org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.Indexer Class Reference

Private Member Functions
BlackboardAttribute	checkAttribute (String key, String value)
void	createMetadataArtifact (AbstractFile aFile, Map< String, String > metadata)
boolean	extractStringsAndIndex (AbstractFile aFile)
boolean	extractTextAndIndex (AbstractFile aFile, Map< String, String > extractedMetadata) throws IngesterException
CharSource	getMetaDataCharSource (Map< String, String > metadata)
void	indexFile (AbstractFile aFile, boolean indexContent)
boolean	indexTextFile (AbstractFile aFile)

Private Attributes
final Logger	logger = Logger.getLogger(Indexer.class.getName())

Detailed Description

File indexer, processes and indexes known/allocated files, unknown/unallocated files and directories accordingly

Definition at line 496 of file KeywordSearchIngestModule.java.

Member Function Documentation

BlackboardAttribute org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.Indexer.checkAttribute ( String  key, String  value  )

private

Definition at line 592 of file KeywordSearchIngestModule.java.

void org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.Indexer.createMetadataArtifact ( AbstractFile  aFile, Map< String, String >  metadata  )

private

Definition at line 555 of file KeywordSearchIngestModule.java.

References org.sleuthkit.autopsy.casemodule.Case.getCurrentCaseThrows(), and org.sleuthkit.autopsy.casemodule.Case.getSleuthkitCase().

boolean org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.Indexer.extractStringsAndIndex ( AbstractFile  aFile )

private

Extract strings using heuristics from the file and add to index.

Parameters

aFile

file to extract strings from, divide into chunks and index

Returns

true if the file was text_ingested, false otherwise

Definition at line 646 of file KeywordSearchIngestModule.java.

References org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.context, org.sleuthkit.autopsy.ingest.IngestJobContext.fileIngestIsCancelled(), org.sleuthkit.autopsy.textextractors.TextExtractor.getReader(), org.sleuthkit.autopsy.textextractors.TextExtractorFactory.getStringsExtractor(), org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.IngestStatus.SKIPPED_ERROR_INDEXING, org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.IngestStatus.SKIPPED_ERROR_TEXTEXTRACT, and org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.IngestStatus.STRINGS_INGESTED.

boolean org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.Indexer.extractTextAndIndex ( AbstractFile  aFile, Map< String, String >  extractedMetadata  ) throws IngesterException

private

Extract text with Tika or other text extraction modules (by streaming) from the file Divide the file into chunks and index the chunks

Parameters

aFile	file to extract strings from, divide into chunks and index
extractedMetadata	Map that will be populated with the file's metadata.

Returns

true if the file was text_ingested, false otherwise

Exceptions

IngesterException

exception thrown if indexing failed

Definition at line 513 of file KeywordSearchIngestModule.java.

References org.sleuthkit.autopsy.ingest.IngestJobContext.fileIngestIsCancelled(), org.sleuthkit.autopsy.textextractors.TextExtractorFactory.getExtractor(), org.sleuthkit.autopsy.textextractors.TextExtractor.getMetadata(), org.sleuthkit.autopsy.textextractors.TextExtractor.getReader(), and org.sleuthkit.autopsy.textextractors.configs.ImageConfig.setOCREnabled().

CharSource org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.Indexer.getMetaDataCharSource ( Map< String, String >  metadata )

private

Pretty print the text extractor metadata.

Parameters

metadata

The Metadata map to wrap as a CharSource

Returns

A CharSource for the given Metadata

Definition at line 628 of file KeywordSearchIngestModule.java.

void org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.Indexer.indexFile ( AbstractFile  aFile, boolean  indexContent  )

private

Adds the file to the index. Detects file type, calls extractors, etc.

Parameters

aFile	File to analyze
indexContent	False if only metadata should be text_ingested. True if content and metadata should be index.

Extract unicode strings from unallocated and unused blocks and carved text files. The reason for performing string extraction on these is because they all may contain multiple encodings which can cause text to be missed by the more specialized text extractors used below.

Definition at line 675 of file KeywordSearchIngestModule.java.

References org.sleuthkit.autopsy.ingest.IngestJobContext.fileIngestIsCancelled(), org.sleuthkit.autopsy.modules.filetypeid.FileTypeDetector.getMIMEType(), org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.IngestStatus.METADATA_INGESTED, org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.IngestStatus.SKIPPED_ERROR_INDEXING, org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.IngestStatus.SKIPPED_ERROR_TEXTEXTRACT, and org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.IngestStatus.TEXT_INGESTED.

Referenced by org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.process().

boolean org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.Indexer.indexTextFile ( AbstractFile  aFile )

private

Adds the text file to the index given an encoding. Returns true if indexing was successful and false otherwise.

Parameters

aFile

Text file to analyze

Definition at line 791 of file KeywordSearchIngestModule.java.

References org.sleuthkit.autopsy.textextractors.TextFileExtractor.getReader(), and org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.IngestStatus.TEXT_INGESTED.

Member Data Documentation

final Logger org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.Indexer.logger = Logger.getLogger(Indexer.class.getName())

private

Definition at line 498 of file KeywordSearchIngestModule.java.

---

The documentation for this class was generated from the following file:

• /home/carriersleuth/repos/autopsy/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/KeywordSearchIngestModule.java