Inherits org.sleuthkit.autopsy.ingest.IngestModule.

Public Member Functions
ProcessResult	process (AbstractFile file)

void	shutDown ()

void	startUp (IngestJobContext context) throws IngestModuleException

Detailed Description

Interface that must be implemented by all file ingest modules. See description of IngestModule for more details on interface behavior.

Definition at line 27 of file FileIngestModule.java.

Member Function Documentation

ProcessResult org.sleuthkit.autopsy.ingest.FileIngestModule.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.

Referenced by org.sleuthkit.autopsy.ingest.FileIngestPipeline.PipelineModule.process().

void org.sleuthkit.autopsy.ingest.FileIngestModule.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.

Referenced by org.sleuthkit.autopsy.ingest.FileIngestPipeline.PipelineModule.shutDown().

void org.sleuthkit.autopsy.ingest.IngestModule.startUp ( IngestJobContext context ) throws IngestModuleException

inherited

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

Referenced by org.sleuthkit.autopsy.ingest.FileIngestPipeline.PipelineModule.startUp().

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

/home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/ingest/FileIngestModule.java

Public Member Functions

Detailed Description

Member Function Documentation