Autopsy  4.1
Graphical digital forensics platform for The Sleuth Kit and other tools.
Public Member Functions | Private Attributes | Static Private Attributes | List of all members
org.sleuthkit.autopsy.modules.embeddedfileextractor.EmbeddedFileExtractorIngestModule Class Reference

Inherits org.sleuthkit.autopsy.ingest.FileIngestModule.

Public Member Functions

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

Private Attributes

SevenZipExtractor archiveExtractor
 
boolean archivextraction
 
IngestJobContext context
 
boolean imageExtraction
 
ImageExtractor imageExtractor
 
long jobId
 
String moduleDirAbsolute
 
String moduleDirRelative
 
final IngestServices services = IngestServices.getInstance()
 

Static Private Attributes

static final Logger logger = Logger.getLogger(EmbeddedFileExtractorIngestModule.class.getName())
 
static final IngestModuleReferenceCounter refCounter = new IngestModuleReferenceCounter()
 

Detailed Description

Embedded File Extractor ingest module extracts embedded files from supported archives and documents, adds extracted embedded DerivedFiles, reschedules extracted DerivedFiles for ingest.

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
fileThe file to analyze.
Returns
A result code indicating success or failure of the processing.

Implements org.sleuthkit.autopsy.ingest.FileIngestModule.

Definition at line 109 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 142 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
contextProvides 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 72 of file EmbeddedFileExtractorIngestModule.java.

References org.sleuthkit.autopsy.casemodule.Case.getCurrentCase(), org.sleuthkit.autopsy.ingest.IngestJobContext.getJobId(), org.sleuthkit.autopsy.casemodule.Case.getModuleDirectory(), and org.sleuthkit.autopsy.casemodule.Case.getModuleOutputDirectoryRelativePath().

Member Data Documentation

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

Definition at line 64 of file EmbeddedFileExtractorIngestModule.java.

boolean org.sleuthkit.autopsy.modules.embeddedfileextractor.EmbeddedFileExtractorIngestModule.archivextraction
private

Definition at line 61 of file EmbeddedFileExtractorIngestModule.java.

IngestJobContext org.sleuthkit.autopsy.modules.embeddedfileextractor.EmbeddedFileExtractorIngestModule.context
private

Definition at line 54 of file EmbeddedFileExtractorIngestModule.java.

boolean org.sleuthkit.autopsy.modules.embeddedfileextractor.EmbeddedFileExtractorIngestModule.imageExtraction
private

Definition at line 62 of file EmbeddedFileExtractorIngestModule.java.

ImageExtractor org.sleuthkit.autopsy.modules.embeddedfileextractor.EmbeddedFileExtractorIngestModule.imageExtractor
private

Definition at line 63 of file EmbeddedFileExtractorIngestModule.java.

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

Definition at line 55 of file EmbeddedFileExtractorIngestModule.java.

final Logger org.sleuthkit.autopsy.modules.embeddedfileextractor.EmbeddedFileExtractorIngestModule.logger = Logger.getLogger(EmbeddedFileExtractorIngestModule.class.getName())
staticprivate

Definition at line 50 of file EmbeddedFileExtractorIngestModule.java.

String org.sleuthkit.autopsy.modules.embeddedfileextractor.EmbeddedFileExtractorIngestModule.moduleDirAbsolute
private

Definition at line 59 of file EmbeddedFileExtractorIngestModule.java.

String org.sleuthkit.autopsy.modules.embeddedfileextractor.EmbeddedFileExtractorIngestModule.moduleDirRelative
private

Definition at line 58 of file EmbeddedFileExtractorIngestModule.java.

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

Definition at line 56 of file EmbeddedFileExtractorIngestModule.java.

final IngestServices org.sleuthkit.autopsy.modules.embeddedfileextractor.EmbeddedFileExtractorIngestModule.services = IngestServices.getInstance()
private

Definition at line 51 of file EmbeddedFileExtractorIngestModule.java.


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

Copyright © 2012-2016 Basis Technology. Generated on: Tue Oct 25 2016
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.