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.ingest.DataSourceIngestPipeline.PipelineModule, org.sleuthkit.autopsy.modules.e01verify.E01VerifyIngestModule, org.sleuthkit.autopsy.modules.encryptiondetection.EncryptionDetectionDataSourceIngestModule, org.sleuthkit.autopsy.modules.iOS.iOSIngestModule, and org.sleuthkit.autopsy.recentactivity.RAImageIngestModule.

Public Member Functions
ProcessResult	process (Content dataSource, DataSourceIngestModuleProgress progressBar)
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().

Parameters

dataSource	The data source to process.
progressBar	A progress bar to be used to report progress.

Returns

A result code indicating success or failure of the processing.

Implemented in org.sleuthkit.autopsy.recentactivity.RAImageIngestModule, org.sleuthkit.autopsy.modules.e01verify.E01VerifyIngestModule, org.sleuthkit.autopsy.test.CustomArtifactsCreatorDataSourceIngestModule, and org.sleuthkit.autopsy.ingest.DataSourceIngestModuleAdapter.

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

Implemented in org.sleuthkit.autopsy.ingest.FileIngestPipeline.PipelineModule, org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule, org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule, org.sleuthkit.autopsy.modules.fileextmismatch.FileExtMismatchIngestModule, org.sleuthkit.autopsy.modules.exif.ExifParserFileIngestModule, org.sleuthkit.autopsy.modules.filetypeid.FileTypeIdIngestModule, org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule, org.sleuthkit.autopsy.modules.embeddedfileextractor.EmbeddedFileExtractorIngestModule, org.sleuthkit.autopsy.modules.e01verify.E01VerifyIngestModule, org.sleuthkit.autopsy.recentactivity.RAImageIngestModule, org.sleuthkit.autopsy.test.CustomArtifactsCreatorDataSourceIngestModule, org.sleuthkit.autopsy.ingest.DataSourceIngestModuleAdapter, and org.sleuthkit.autopsy.ingest.FileIngestModuleAdapter.

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/DataSourceIngestModule.java