Autopsy  4.19.3
Graphical digital forensics platform for The Sleuth Kit and other tools.
Public Member Functions | List of all members
org.sleuthkit.autopsy.ingest.DataSourceIngestModule Interface Reference

Inherits org.sleuthkit.autopsy.ingest.IngestModule.

Inherited by org.sleuthkit.autopsy.examples.SampleDataSourceIngestModule, org.sleuthkit.autopsy.ingest.DataSourceIngestModuleAdapter, org.sleuthkit.autopsy.modules.dataSourceIntegrity.DataSourceIntegrityIngestModule, org.sleuthkit.autopsy.modules.drones.DroneIngestModule, org.sleuthkit.autopsy.modules.encryptiondetection.EncryptionDetectionDataSourceIngestModule, org.sleuthkit.autopsy.modules.leappanalyzers.ALeappAnalyzerIngestModule, org.sleuthkit.autopsy.modules.leappanalyzers.ILeappAnalyzerIngestModule, org.sleuthkit.autopsy.modules.plaso.PlasoIngestModule, and org.sleuthkit.autopsy.recentactivity.RAImageIngestModule.

Public Member Functions

ProcessResult process (Content dataSource, DataSourceIngestModuleProgress progressBar)
 
default void shutDown ()
 
default void startUp (IngestJobContext context) throws IngestModuleException
 

Detailed Description

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

Definition at line 27 of file DataSourceIngestModule.java.

Member Function Documentation

ProcessResult org.sleuthkit.autopsy.ingest.DataSourceIngestModule.process ( Content  dataSource,
DataSourceIngestModuleProgress  progressBar 
)

Processes a data source. Called once between calls to startUp() and shutDown().

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. 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
dataSourceThe data source to process.
progressBarA progress bar to be used to report progress.
Returns
A result code indicating success or failure of the processing.

Implemented in org.sleuthkit.autopsy.modules.plaso.PlasoIngestModule, org.sleuthkit.autopsy.modules.leappanalyzers.ALeappAnalyzerIngestModule, org.sleuthkit.autopsy.modules.leappanalyzers.ILeappAnalyzerIngestModule, org.sleuthkit.autopsy.modules.dataSourceIntegrity.DataSourceIntegrityIngestModule, org.sleuthkit.autopsy.recentactivity.RAImageIngestModule, org.sleuthkit.autopsy.test.CustomArtifactsCreatorDataSourceIngestModule, org.sleuthkit.autopsy.modules.drones.DroneIngestModule, and org.sleuthkit.autopsy.ingest.DataSourceIngestModuleAdapter.

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
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

Implemented in org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule, org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule, org.sleuthkit.autopsy.modules.plaso.PlasoIngestModule, org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule, org.sleuthkit.autopsy.modules.fileextmismatch.FileExtMismatchIngestModule, org.sleuthkit.autopsy.centralrepository.ingestmodule.CentralRepoDataArtifactIngestModule, org.sleuthkit.autopsy.modules.leappanalyzers.ALeappAnalyzerIngestModule, org.sleuthkit.autopsy.modules.leappanalyzers.ILeappAnalyzerIngestModule, org.sleuthkit.autopsy.modules.filetypeid.FileTypeIdIngestModule, org.sleuthkit.autopsy.modules.yara.YaraIngestModule, org.sleuthkit.autopsy.modules.embeddedfileextractor.EmbeddedFileExtractorIngestModule, org.sleuthkit.autopsy.modules.pictureanalyzer.PictureAnalyzerIngestModule, org.sleuthkit.autopsy.modules.dataSourceIntegrity.DataSourceIntegrityIngestModule, org.sleuthkit.autopsy.recentactivity.RAImageIngestModule, org.sleuthkit.autopsy.test.CustomArtifactsCreatorDataSourceIngestModule, org.sleuthkit.autopsy.modules.drones.DroneIngestModule, org.sleuthkit.autopsy.keywordsearch.KwsAnalysisResultIngestModule, and org.sleuthkit.autopsy.keywordsearch.KwsDataArtifactIngestModule.

Definition at line 73 of file IngestModule.java.


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

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