Autopsy  4.19.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 addDataArtifactsToJob (List< DataArtifact > artifacts)
 
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 IngestJobPipeline ingestJobPipeline
 

Detailed Description

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

Definition at line 30 of file IngestJobContext.java.

Member Function Documentation

void org.sleuthkit.autopsy.ingest.IngestJobContext.addDataArtifactsToJob ( List< DataArtifact >  artifacts)

Adds one or more data artifacts to the ingest job for processing by its data artifact ingest modules.

Parameters
artifactsThe artifacts.

Definition at line 167 of file IngestJobContext.java.

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
filesThe files.

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

boolean org.sleuthkit.autopsy.ingest.IngestJobContext.dataSourceIngestIsCancelled ( )
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 104 of file IngestJobContext.java.

Referenced by org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.addEmailArtifact(), org.sleuthkit.autopsy.keywordsearch.IngestSearchRunner.Searcher.doInBackground(), org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.Indexer.extractStringsAndIndex(), org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.getExtractor(), org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.Indexer.indexFile(), org.sleuthkit.autopsy.modules.pictureanalyzer.PictureAnalyzerIngestModule.process(), org.sleuthkit.autopsy.modules.pictureanalyzer.impls.EXIFProcessor.process(), org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.process(), org.sleuthkit.autopsy.modules.pictureanalyzer.impls.HEICProcessor.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.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 ( )
String org.sleuthkit.autopsy.ingest.IngestJobContext.getExecutionContext ( )

Gets the execution context identifier of the ingest job.

Returns
The context string.

Definition at line 49 of file IngestJobContext.java.

long org.sleuthkit.autopsy.ingest.IngestJobContext.getJobId ( )
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 81 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 134 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 147 of file IngestJobContext.java.

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

Member Data Documentation

final IngestJobPipeline org.sleuthkit.autopsy.ingest.IngestJobContext.ingestJobPipeline
private

Definition at line 32 of file IngestJobContext.java.


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

Copyright © 2012-2021 Basis Technology. Generated on: Fri Aug 6 2021
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.