Autopsy  4.5.0
Graphical digital forensics platform for The Sleuth Kit and other tools.
Public Member Functions | Private Attributes | List of all members
org.sleuthkit.autopsy.ingest.FileIngestPipeline.PipelineModule Class Reference

Inherits org.sleuthkit.autopsy.ingest.FileIngestModule.

Public Member Functions

IngestModule.ProcessResult process (AbstractFile file)
 
void shutDown ()
 
void startUp (IngestJobContext context) throws IngestModuleException
 

Private Attributes

final String displayName
 
final FileIngestModule module
 

Detailed Description

This class decorates a file level ingest module with a display name.

Definition at line 177 of file FileIngestPipeline.java.

Member Function Documentation

IngestModule.ProcessResult org.sleuthkit.autopsy.ingest.FileIngestPipeline.PipelineModule.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 218 of file FileIngestPipeline.java.

References org.sleuthkit.autopsy.ingest.FileIngestModule.process().

void org.sleuthkit.autopsy.ingest.FileIngestPipeline.PipelineModule.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 223 of file FileIngestPipeline.java.

References org.sleuthkit.autopsy.ingest.FileIngestModule.shutDown().

void org.sleuthkit.autopsy.ingest.FileIngestPipeline.PipelineModule.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 213 of file FileIngestPipeline.java.

References org.sleuthkit.autopsy.ingest.IngestModule.startUp().

Member Data Documentation

final String org.sleuthkit.autopsy.ingest.FileIngestPipeline.PipelineModule.displayName
private

Definition at line 180 of file FileIngestPipeline.java.

final FileIngestModule org.sleuthkit.autopsy.ingest.FileIngestPipeline.PipelineModule.module
private

Definition at line 179 of file FileIngestPipeline.java.


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

Copyright © 2012-2016 Basis Technology. Generated on: Sun Dec 10 2017
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.