Inherits org.sleuthkit.autopsy.ingest.FileIngestModule.

Inherited by org.sleuthkit.autopsy.modules.embeddedfileextractor.EmbeddedFileExtractorIngestModule, org.sleuthkit.autopsy.modules.encryptiondetection.EncryptionDetectionFileIngestModule, org.sleuthkit.autopsy.modules.pictureanalyzer.PictureAnalyzerIngestModule, org.sleuthkit.autopsy.modules.yara.YaraIngestModule, org.sleuthkit.autopsy.test.CustomArtifactsCreatorFileIngestModule, and org.sleuthkit.autopsy.test.InterestingArtifactCreatorIngestModule.

Public Member Functions
abstract ProcessResult	process (AbstractFile file)

default void	shutDown ()

default void	startUp (IngestJobContext context) throws IngestModuleException

Detailed Description

DO NOT USE: As of Java 8, interfaces can have default methods. IngestModule now provides default no-op versions of startUp() and shutDown(). This class is no longer needed and can be DEPRECATED when convenient.

An adapter that provides no-op implementations of the startUp() and shutDown() methods for file ingest modules.

Definition at line 32 of file FileIngestModuleAdapter.java.

Member Function Documentation

abstract ProcessResult org.sleuthkit.autopsy.ingest.FileIngestModuleAdapter.process ( AbstractFile file )

abstract

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

IMPORTANT: In addition to returning ProcessResult.OK or ProcessResult.ERROR, modules should log all errors using methods provided by the org.sleuthkit.autopsy.coreutils.Logger class. Log messages should include the name and object ID of the data being processed and any other information that would be useful for debugging. If an exception has been caught by the module, the exception should be sent to the logger along with the log message so that a stack trace will appear in the application log.

Parameters

file	The file to analyze.

Returns: A result code indicating success or failure of the processing.

Implements org.sleuthkit.autopsy.ingest.FileIngestModule.

default void org.sleuthkit.autopsy.ingest.IngestModule.shutDown ( )

inherited

Invoked by Autopsy when an ingest job is completed (either because the data has been analyzed or because the job was cancelled), 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.

IMPORTANT: If the module instances must share resources, the modules are responsible for synchronizing access to the shared resources and doing reference counting as required to release those resources correctly. Also, more than one ingest job may be in progress at any given time. This must also be taken into consideration when sharing resources between module instances. See IngestModuleReferenceCounter.

Implemented in org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule, org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule, org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule, org.sleuthkit.autopsy.centralrepository.ingestmodule.CentralRepoDataArtifactIngestModule, org.sleuthkit.autopsy.modules.filetypeid.FileTypeIdIngestModule, org.sleuthkit.autopsy.modules.fileextmismatch.FileExtMismatchIngestModule, org.sleuthkit.autopsy.modules.embeddedfileextractor.EmbeddedFileExtractorIngestModule, org.sleuthkit.autopsy.recentactivity.RAImageIngestModule, and org.sleuthkit.autopsy.modules.yara.YaraIngestModule.

Definition at line 91 of file IngestModule.java.

default 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 startUp() are logged and stop processing of the data source.

IMPORTANT: If the module instances must share resources, the modules are responsible for synchronizing access to the shared resources and doing reference counting as required to release those resources correctly. Also, more than one ingest job may be in progress at any given time. This must also be taken into consideration when sharing resources between module instances. See IngestModuleReferenceCounter.

IMPORTANT: Start up IngestModuleException messages are displayed to the user, if a user is present. Therefore, an exception to the policy that exception messages are not localized is appropriate in this method. Also, the exception messages should be user-friendly.

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

Definition at line 73 of file IngestModule.java.

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

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

Public Member Functions

Detailed Description

Member Function Documentation