org.sleuthkit.autopsy.ingest.IngestJobContext Class Reference

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

Private Attributes
final DataSourceIngestJob	ingestJob

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, i.e., extracted or carved files, to the ingest job associated with this context.

Parameters

files

The files to be added.

Definition at line 119 of file IngestJobContext.java.

Referenced by org.sleuthkit.autopsy.ingest.IngestJobContext.scheduleFiles().

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

(

)

Allows a data source ingest module to determine whether or not cancellation of the data source ingest part of the ingest job associated with this context has been requested.

Returns

True or false.

Definition at line 76 of file IngestJobContext.java.

Referenced by org.sleuthkit.autopsy.ingest.IngestJobContext.isJobCancelled(), org.sleuthkit.autopsy.modules.e01verify.E01VerifyIngestModule.process(), org.sleuthkit.autopsy.recentactivity.RAImageIngestModule.process(), and org.sleuthkit.autopsy.ingest.DataSourceIngestModuleProcessTerminator.shouldTerminateProcess().

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

(

)

Allows a file ingest module to determine whether or not cancellation of the file ingest part of the ingest job associated with this context has been requested.

Returns

True or false.

Definition at line 87 of file IngestJobContext.java.

Referenced by org.sleuthkit.autopsy.ingest.FileIngestModuleProcessTerminator.shouldTerminateProcess(), and org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.shutDown().

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

(

)

Gets the data source associated with this context.

Returns

The data source.

Definition at line 42 of file IngestJobContext.java.

References org::sleuthkit::datamodel::Content.getDataSource().

Referenced by org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.startUp().

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

(

)

Gets the identifier of the ingest job associated with this context.

Returns

The ingest job identifier.

Definition at line 51 of file IngestJobContext.java.

Referenced by org.sleuthkit.autopsy.examples.SampleExecutableDataSourceIngestModule.generateSimulatedDerivedFiles(), org.sleuthkit.autopsy.examples.SampleExecutableDataSourceIngestModule.generateSimulatedReports(), org.sleuthkit.autopsy.examples.SampleExecutableDataSourceIngestModule.process(), org.sleuthkit.autopsy.modules.embeddedfileextractor.EmbeddedFileExtractorIngestModule.startUp(), org.sleuthkit.autopsy.examples.SampleExecutableDataSourceIngestModule.startUp(), and org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.startUp().

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

(

)

Queries whether or not cancellation of the data source ingest part of the ingest job associated with this context has been requested.

Returns

True or false.

Deprecated:

Use dataSourceIngestIsCancelled() or fileIngestIsCancelled() instead.

Definition at line 65 of file IngestJobContext.java.

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

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

(

)

Queries whether or not unallocated space should be processed for the ingest job associated with this context.

Returns

True or false.

Definition at line 97 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 109 of file IngestJobContext.java.

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

Member Data Documentation

final DataSourceIngestJob org.sleuthkit.autopsy.ingest.IngestJobContext.ingestJob

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