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

Private Member Functions
boolean	extractTextAndIndex (AbstractFile aFile, String detectedFormat) throws IngesterException
boolean	extractStringsAndIndex (AbstractFile aFile)
boolean	isTextExtractSupported (AbstractFile aFile, String detectedFormat)
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 367 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 411 of file KeywordSearchIngestModule.java.

References org::sleuthkit::datamodel::AbstractContent.getId(), org::sleuthkit::datamodel::AbstractContent.getName(), org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.putIngestStatus(), 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.

Referenced by org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.Indexer.indexFile().

boolean org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.Indexer.extractTextAndIndex ( AbstractFile  aFile, String  detectedFormat  ) 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
detectedFormat	mime-type detected, or null if none detected

Returns

true if the file was text_ingested, false otherwise

Exceptions

IngesterException

exception thrown if indexing failed

Definition at line 382 of file KeywordSearchIngestModule.java.

Referenced by org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.Indexer.indexFile().

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

References org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.Indexer.extractStringsAndIndex(), org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.Indexer.extractTextAndIndex(), org.sleuthkit.autopsy.modules.filetypeid.FileTypeDetector.getFileType(), org::sleuthkit::datamodel::AbstractContent.getId(), org::sleuthkit::datamodel::AbstractContent.getName(), org::sleuthkit::datamodel::AbstractFile.getSize(), org::sleuthkit::datamodel::AbstractFile.getType(), org::sleuthkit::datamodel::AbstractFile.isDir(), org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.Indexer.isTextExtractSupported(), org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.IngestStatus.METADATA_INGESTED, org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.putIngestStatus(), org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.IngestStatus.SKIPPED_ERROR_INDEXING, org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.IngestStatus.SKIPPED_ERROR_TEXTEXTRACT, org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.IngestStatus.TEXT_INGESTED, org::sleuthkit::datamodel::TskData::TSK_DB_FILES_TYPE_ENUM.UNALLOC_BLOCKS, and org::sleuthkit::datamodel::TskData::TSK_DB_FILES_TYPE_ENUM.UNUSED_BLOCKS.

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

boolean org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.Indexer.isTextExtractSupported ( AbstractFile  aFile, String  detectedFormat  )

private

Check with every extractor if it supports the file with the detected format

Parameters

aFile	file to check for
detectedFormat	mime-type with detected format (such as text/plain) or null if not detected

Returns

true if text extraction is supported

Definition at line 437 of file KeywordSearchIngestModule.java.

Referenced by org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.Indexer.indexFile().

Member Data Documentation

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

private

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