org.sleuthkit.autopsy.ingest.IngestJobContext Class Reference

Public Member Functions
void	addFilesToJob (List< AbstractFile > files)
boolean	dataArtifactIngestIsCancelled ()
boolean	dataSourceIngestIsCancelled ()
boolean	fileIngestIsCancelled ()
Content	getDataSource ()
String	getExecutionContext ()
long	getJobId ()
boolean	isJobCancelled ()
boolean	processingUnallocatedSpace ()
void	scheduleFiles (List< AbstractFile > files)

Private Attributes
final IngestJobExecutor	ingestJobExecutor

Detailed Description

Provides an ingest module with services specific to the ingest job of which the module is a part.

Definition at line 29 of file IngestJobContext.java.

Member Function Documentation

void org.sleuthkit.autopsy.ingest.IngestJobContext.addFilesToJob

(

List< AbstractFile >

files

)

Adds one or more files, e.g., extracted or carved files, to the ingest job for processing by its file ingest modules.

Parameters

files

The files.

Definition at line 156 of file IngestJobContext.java.

Referenced by org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.processEmails(), org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.processEMLFile(), and org.sleuthkit.autopsy.ingest.IngestJobContext.scheduleFiles().

boolean org.sleuthkit.autopsy.ingest.IngestJobContext.dataArtifactIngestIsCancelled

(

)

Checks whether or not cancellation of the currently running data artifact ingest module for the ingest job has been requested. Data artifact ingest modules should check this periodically and break off processing if the method returns true.

Returns

True or false.

Definition at line 119 of file IngestJobContext.java.

boolean org.sleuthkit.autopsy.ingest.IngestJobContext.dataSourceIngestIsCancelled

(

)

Indicates whether or not cancellation of the currently running data source level ingest module has been requested. Data source level ingest modules should check this periodically and break off processing if the method returns true.

Returns

True or false.

Definition at line 92 of file IngestJobContext.java.

Referenced by org.sleuthkit.autopsy.modules.leappanalyzers.LeappFileProcessor.checkCancelled(), org.sleuthkit.autopsy.modules.plaso.PlasoIngestModule.createPlasoArtifacts(), org.sleuthkit.autopsy.modules.leappanalyzers.ALeappAnalyzerIngestModule.extractFilesFromDataSource(), org.sleuthkit.autopsy.modules.leappanalyzers.ILeappAnalyzerIngestModule.extractFilesFromDataSource(), org.sleuthkit.autopsy.modules.drones.DroneIngestModule.process(), org.sleuthkit.autopsy.recentactivity.RAImageIngestModule.process(), org.sleuthkit.autopsy.modules.dataSourceIntegrity.DataSourceIntegrityIngestModule.process(), org.sleuthkit.autopsy.modules.plaso.PlasoIngestModule.process(), org.sleuthkit.autopsy.modules.leappanalyzers.ALeappAnalyzerIngestModule.processALeappFile(), org.sleuthkit.autopsy.modules.leappanalyzers.ALeappAnalyzerIngestModule.processALeappFs(), org.sleuthkit.autopsy.modules.leappanalyzers.ILeappAnalyzerIngestModule.processILeappFile(), org.sleuthkit.autopsy.modules.leappanalyzers.ILeappAnalyzerIngestModule.processILeappFs(), and org.sleuthkit.autopsy.ingest.DataSourceIngestModuleProcessTerminator.shouldTerminateProcess().

boolean org.sleuthkit.autopsy.ingest.IngestJobContext.fileIngestIsCancelled

(

)

Indicates whether or not cancellation of the currently running file level ingest module has been requested. File level ingest modules should check this periodically and break off processing if the method returns true.

Returns

True or false.

Definition at line 103 of file IngestJobContext.java.

Referenced by org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.addEmailArtifact(), org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.extractStringsAndIndex(), org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.getExtractor(), org.sleuthkit.autopsy.modules.pictureanalyzer.PictureAnalyzerIngestModule.process(), org.sleuthkit.autopsy.modules.pictureanalyzer.impls.EXIFProcessor.process(), org.sleuthkit.autopsy.modules.pictureanalyzer.impls.HEICProcessor.process(), org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.process(), org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.process(), org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.processEmails(), org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.processMBox(), org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.processMboxFile(), org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.processPst(), org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.searchFile(), org.sleuthkit.autopsy.ingest.FileIngestModuleProcessTerminator.shouldTerminateProcess(), org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.shutDown(), and org.sleuthkit.autopsy.modules.embeddedfileextractor.FileTaskExecutor.TaskTerminator.stopTaskAttempts().

Content org.sleuthkit.autopsy.ingest.IngestJobContext.getDataSource

(

)

Gets the data source for the ingest job.

Returns

The data source.

Definition at line 57 of file IngestJobContext.java.

Referenced by org.sleuthkit.autopsy.centralrepository.ingestmodule.CentralRepoDataArtifactIngestModule.analyzeOsAccounts(), org.sleuthkit.autopsy.centralrepository.ingestmodule.CentralRepoDataArtifactIngestModule.makeAnalysisResults(), org.sleuthkit.autopsy.modules.leappanalyzers.ALeappAnalyzerIngestModule.process(), org.sleuthkit.autopsy.modules.leappanalyzers.ILeappAnalyzerIngestModule.process(), and org.sleuthkit.autopsy.centralrepository.ingestmodule.CentralRepoDataArtifactIngestModule.syncDataSourceHashes().

String org.sleuthkit.autopsy.ingest.IngestJobContext.getExecutionContext

(

)

Gets the execution context identifier of the ingest job.

Returns

The context string.

Definition at line 48 of file IngestJobContext.java.

long org.sleuthkit.autopsy.ingest.IngestJobContext.getJobId

(

)

Gets the unique identifier for the ingest job.

Returns

The ID.

Definition at line 66 of file IngestJobContext.java.

Referenced by org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.addEmailArtifact(), org.sleuthkit.autopsy.centralrepository.ingestmodule.CentralRepoDataArtifactIngestModule.analyzeOsAccounts(), org.sleuthkit.autopsy.modules.leappanalyzers.LeappFileProcessor.createCalllogRelationship(), org.sleuthkit.autopsy.modules.leappanalyzers.LeappFileProcessor.createContactRelationship(), org.sleuthkit.autopsy.modules.yara.YaraIngestModule.createLocalCopy(), org.sleuthkit.autopsy.modules.leappanalyzers.LeappFileProcessor.createMessageRelationship(), org.sleuthkit.autopsy.modules.plaso.PlasoIngestModule.createPlasoArtifacts(), org.sleuthkit.autopsy.modules.leappanalyzers.LeappFileProcessor.createRoute(), org.sleuthkit.autopsy.modules.leappanalyzers.LeappFileProcessor.createTrackpoint(), org.sleuthkit.autopsy.centralrepository.ingestmodule.CentralRepoDataArtifactIngestModule.makeAnalysisResults(), org.sleuthkit.autopsy.keywordsearch.KwsAnalysisResultIngestModule.process(), org.sleuthkit.autopsy.keywordsearch.KwsDataArtifactIngestModule.process(), org.sleuthkit.autopsy.test.CustomArtifactsCreatorDataSourceIngestModule.process(), org.sleuthkit.autopsy.modules.pictureanalyzer.impls.EXIFProcessor.process(), org.sleuthkit.autopsy.modules.dataSourceIntegrity.DataSourceIntegrityIngestModule.process(), org.sleuthkit.autopsy.modules.yara.YaraIngestModule.process(), org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.process(), org.sleuthkit.autopsy.centralrepository.ingestmodule.CentralRepoDataArtifactIngestModule.process(), org.sleuthkit.autopsy.modules.leappanalyzers.LeappFileProcessor.processFile(), org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.processPst(), org.sleuthkit.autopsy.centralrepository.ingestmodule.CentralRepoDataArtifactIngestModule.shutDown(), org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.shutDown(), org.sleuthkit.autopsy.modules.embeddedfileextractor.EmbeddedFileExtractorIngestModule.startUp(), org.sleuthkit.autopsy.modules.yara.YaraIngestModule.startUp(), org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.startUp(), and org.sleuthkit.autopsy.centralrepository.ingestmodule.CentralRepoDataArtifactIngestModule.syncDataSourceHashes().

boolean org.sleuthkit.autopsy.ingest.IngestJobContext.isJobCancelled

(

)

Indicates whether or not cancellation of the ingest job has been requested.

Returns

True or false.

Deprecated:

Modules should call a type-specific cancellation check method instead.

Definition at line 80 of file IngestJobContext.java.

boolean org.sleuthkit.autopsy.ingest.IngestJobContext.processingUnallocatedSpace

(

)

Queries whether or not unallocated space should be processed for the ingest job.

Returns

True or false.

Definition at line 133 of file IngestJobContext.java.

void org.sleuthkit.autopsy.ingest.IngestJobContext.scheduleFiles

(

List< AbstractFile >

files

)

Adds one or more files, i.e., extracted or carved files, to the ingest job associated with this context.

Parameters

files

The files to be added.

Deprecated:

use addFilesToJob() instead.

Definition at line 146 of file IngestJobContext.java.

References org.sleuthkit.autopsy.ingest.IngestJobContext.addFilesToJob().

Member Data Documentation

final IngestJobExecutor org.sleuthkit.autopsy.ingest.IngestJobContext.ingestJobExecutor

private

Definition at line 31 of file IngestJobContext.java.

---

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

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