Autopsy  4.19.3
Graphical digital forensics platform for The Sleuth Kit and other tools.
Private Member Functions | Private Attributes | List of all members
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 (Optional< TextExtractor > extractorOptional, AbstractFile aFile, Map< String, String > extractedMetadata) throws IngesterException
 
CharSource getMetaDataCharSource (Map< String, String > metadata)
 
void indexFile (Optional< TextExtractor > extractor, AbstractFile aFile, String mimeType, 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 565 of file KeywordSearchIngestModule.java.

Member Function Documentation

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

Definition at line 661 of file KeywordSearchIngestModule.java.

void org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.Indexer.createMetadataArtifact ( AbstractFile  aFile,
Map< String, String >  metadata 
)
private
boolean org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.Indexer.extractStringsAndIndex ( AbstractFile  aFile)
private
boolean org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.Indexer.extractTextAndIndex ( Optional< TextExtractor extractorOptional,
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
extractorOptionalThe textExtractor to use with this file or empty.
aFilefile to extract strings from, divide into chunks and index
extractedMetadataMap that will be populated with the file's metadata.
Returns
true if the file was text_ingested, false otherwise
Exceptions
IngesterExceptionexception thrown if indexing failed

Definition at line 585 of file KeywordSearchIngestModule.java.

References org.sleuthkit.autopsy.textextractors.TextExtractor.getMetadata(), and org.sleuthkit.autopsy.textextractors.TextExtractor.getReader().

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

Pretty print the text extractor metadata.

Parameters
metadataThe Metadata map to wrap as a CharSource
Returns
A CharSource for the given Metadata

Definition at line 696 of file KeywordSearchIngestModule.java.

void org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.Indexer.indexFile ( Optional< TextExtractor extractor,
AbstractFile  aFile,
String  mimeType,
boolean  indexContent 
)
private

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

Parameters
extractorThe textExtractor to use with this file or empty if no extractor found.
aFileFile to analyze.
mimeTypeThe file mime type.
indexContentFalse 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 746 of file KeywordSearchIngestModule.java.

References org.sleuthkit.autopsy.ingest.IngestJobContext.fileIngestIsCancelled(), 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
aFileText file to analyze

Definition at line 861 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 567 of file KeywordSearchIngestModule.java.


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

Copyright © 2012-2022 Basis Technology. Generated on: Thu Sep 29 2022
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.