org.sleuthkit.autopsy.modules.embeddedfileextractor.EmbeddedFileExtractorIngestModule Class Reference

Inherits org.sleuthkit.autopsy.ingest.FileIngestModuleAdapter.

Public Member Functions
ProcessResult	process (AbstractFile abstractFile)
void	shutDown ()
void	startUp (IngestJobContext context) throws IngestModuleException

Private Attributes
SevenZipExtractor	archiveExtractor
FileTypeDetector	fileTypeDetector
long	jobId
MSOfficeEmbeddedContentExtractor	officeExtractor

Static Private Attributes
static final ConcurrentHashMap< Long, ConcurrentHashMap< Long, Archive > >	mapOfDepthTrees = new ConcurrentHashMap<>()
static final IngestModuleReferenceCounter	refCounter = new IngestModuleReferenceCounter()

Detailed Description

A file level ingest module that extracts embedded files from supported archive and document formats.

Definition at line 48 of file EmbeddedFileExtractorIngestModule.java.

Member Function Documentation

ProcessResult org.sleuthkit.autopsy.modules.embeddedfileextractor.EmbeddedFileExtractorIngestModule.process

(

AbstractFile

file

)

Processes a file. Called between calls to startUp() and shutDown(). Will be called for each file in a data source.

Parameters

file	The file to analyze.

Returns

A result code indicating success or failure of the processing.

Implements org.sleuthkit.autopsy.ingest.FileIngestModule.

Definition at line 129 of file EmbeddedFileExtractorIngestModule.java.

References org.sleuthkit.autopsy.ingest.IngestModule.ProcessResult.OK.

void org.sleuthkit.autopsy.modules.embeddedfileextractor.EmbeddedFileExtractorIngestModule.shutDown

(

)

Invoked by Autopsy when an ingest job is completed (either because the data has been analyzed or because the job was canceled - check IngestJobContext.fileIngestIsCancelled()), before the ingest module instance is discarded. The module should respond by doing things like releasing private resources, submitting final results, and posting a final ingest message.

Implements org.sleuthkit.autopsy.ingest.FileIngestModule.

Definition at line 165 of file EmbeddedFileExtractorIngestModule.java.

References org.sleuthkit.autopsy.ingest.IngestModuleReferenceCounter.decrementAndGet().

void org.sleuthkit.autopsy.modules.embeddedfileextractor.EmbeddedFileExtractorIngestModule.startUp

(

IngestJobContext

context

)

throws IngestModuleException

Invoked by Autopsy to allow an ingest module instance to set up any internal data structures and acquire any private resources it will need during an ingest job. If the module depends on loading any resources, it should do so in this method so that it can throw an exception in the case of an error and alert the user. Exceptions that are thrown from process() and shutDown() are logged, but do not stop processing of the data source.

Parameters

context

Provides data and services specific to the ingest job and the ingest pipeline of which the module is a part.

Exceptions

org.sleuthkit.autopsy.ingest.IngestModule.IngestModuleException

Implements org.sleuthkit.autopsy.ingest.IngestModule.

Definition at line 66 of file EmbeddedFileExtractorIngestModule.java.

References org.sleuthkit.autopsy.casemodule.Case.getCurrentCaseThrows(), org.sleuthkit.autopsy.casemodule.Case.getModuleDirectory(), org.sleuthkit.autopsy.casemodule.Case.getModuleOutputDirectoryRelativePath(), and org.sleuthkit.autopsy.ingest.IngestModuleReferenceCounter.incrementAndGet().

Member Data Documentation

SevenZipExtractor org.sleuthkit.autopsy.modules.embeddedfileextractor.EmbeddedFileExtractorIngestModule.archiveExtractor

private

Definition at line 54 of file EmbeddedFileExtractorIngestModule.java.

FileTypeDetector org.sleuthkit.autopsy.modules.embeddedfileextractor.EmbeddedFileExtractorIngestModule.fileTypeDetector

private

Definition at line 55 of file EmbeddedFileExtractorIngestModule.java.

long org.sleuthkit.autopsy.modules.embeddedfileextractor.EmbeddedFileExtractorIngestModule.jobId

private

Definition at line 56 of file EmbeddedFileExtractorIngestModule.java.

final ConcurrentHashMap<Long, ConcurrentHashMap<Long, Archive> > org.sleuthkit.autopsy.modules.embeddedfileextractor.EmbeddedFileExtractorIngestModule.mapOfDepthTrees = new ConcurrentHashMap<>()

staticprivate

Definition at line 51 of file EmbeddedFileExtractorIngestModule.java.

MSOfficeEmbeddedContentExtractor org.sleuthkit.autopsy.modules.embeddedfileextractor.EmbeddedFileExtractorIngestModule.officeExtractor

private

Definition at line 53 of file EmbeddedFileExtractorIngestModule.java.

final IngestModuleReferenceCounter org.sleuthkit.autopsy.modules.embeddedfileextractor.EmbeddedFileExtractorIngestModule.refCounter = new IngestModuleReferenceCounter()

staticprivate

Definition at line 52 of file EmbeddedFileExtractorIngestModule.java.

---

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

• /home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/modules/embeddedfileextractor/EmbeddedFileExtractorIngestModule.java