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

Private Member Functions
boolean	extractStringsAndIndex (AbstractFile aFile)
boolean	extractTextAndIndex (AbstractFile aFile) throws IngesterException
CharSource	getMetaDataCharSource (Map< String, String > metadata)
void	indexFile (AbstractFile aFile, boolean indexContent)

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 466 of file KeywordSearchIngestModule.java.

Member Function Documentation

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 546 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 ) 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

Returns

true if the file was text_ingested, false otherwise

Exceptions

IngesterException

exception thrown if indexing failed

Definition at line 482 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 528 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.

Definition at line 575 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().

Member Data Documentation

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

private

Definition at line 468 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