Autopsy  4.13.0
Graphical digital forensics platform for The Sleuth Kit and other tools.
Public Member Functions | Private Attributes | List of all members
org.sleuthkit.autopsy.ingest.IngestJobContext Class Reference

Public Member Functions

void addFilesToJob (List< AbstractFile > files)
 
boolean dataSourceIngestIsCancelled ()
 
boolean fileIngestIsCancelled ()
 
Content getDataSource ()
 
String getExecutionContext ()
 
long getJobId ()
 
boolean isJobCancelled ()
 
boolean processingUnallocatedSpace ()
 
void scheduleFiles (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
filesThe files to be added.

Definition at line 129 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.dataSourceIngestIsCancelled ( )
boolean org.sleuthkit.autopsy.ingest.IngestJobContext.fileIngestIsCancelled ( )
Content org.sleuthkit.autopsy.ingest.IngestJobContext.getDataSource ( )

Gets the data source associated with this context.

Returns
The data source.

Definition at line 51 of file IngestJobContext.java.

Referenced by org.sleuthkit.autopsy.keywordsearch.IngestSearchRunner.SearchJobInfo.SearchJobInfo().

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

Gets the ingest job execution context identifier.

Returns
The context string.

Definition at line 42 of file IngestJobContext.java.

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 60 of file IngestJobContext.java.

Referenced by org.sleuthkit.autopsy.keywordsearch.IngestSearchRunner.SearchJobInfo.SearchJobInfo(), 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 74 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 106 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
filesThe files to be added.
Deprecated:
use addFilesToJob() instead

Definition at line 119 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:

Copyright © 2012-2019 Basis Technology. Generated on: Tue Jan 7 2020
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.