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

Classes

class  DataSourceIngestModuleHandle
 
class  ProgressSnapshot
 

Public Member Functions

long getId ()
 
ProgressSnapshot getSnapshot ()
 
ProgressSnapshot getSnapshot (boolean getIngestTasksSnapshot)
 
void cancel ()
 
boolean isCancelled ()
 

Private Attributes

final long id
 
final Map< Long, DataSourceIngestJob > dataSourceJobs
 
final AtomicInteger incompleteJobsCount
 
boolean started
 
volatile boolean cancelled
 

Static Private Attributes

static final AtomicLong nextId = new AtomicLong(0L)
 

Detailed Description

Runs a collection of data sources through a set of ingest modules specified via ingest job settings.

This class is thread-safe.

Definition at line 38 of file IngestJob.java.

Member Function Documentation

void org.sleuthkit.autopsy.ingest.IngestJob.cancel ( )

Requests cancellation of this ingest job, which means discarding unfinished tasks and stopping the ingest pipelines. Returns immediately, but there may be a delay before all of the ingest modules in the pipelines respond by stopping processing.

Definition at line 166 of file IngestJob.java.

Referenced by org.sleuthkit.autopsy.ingest.IngestManager.cancelAllIngestJobs().

long org.sleuthkit.autopsy.ingest.IngestJob.getId ( )

Gets the unique identifier assigned to this ingest job.

Returns
The job identifier.

Definition at line 71 of file IngestJob.java.

References org.sleuthkit.autopsy.ingest.IngestJob.id.

Referenced by org.sleuthkit.autopsy.ingest.IngestManager.IngestJobStarter.call(), and org.sleuthkit.autopsy.ingest.IngestManager.startIngestJob().

ProgressSnapshot org.sleuthkit.autopsy.ingest.IngestJob.getSnapshot ( )

Gets a snapshot of the progress of this ingest job.

Returns
The snapshot.

Definition at line 133 of file IngestJob.java.

ProgressSnapshot org.sleuthkit.autopsy.ingest.IngestJob.getSnapshot ( boolean  getIngestTasksSnapshot)

Gets a snapshot of the progress of this ingest job.

Returns
The snapshot.

Definition at line 142 of file IngestJob.java.

boolean org.sleuthkit.autopsy.ingest.IngestJob.isCancelled ( )

Queries whether or not cancellation of this ingest job has been requested.

Returns
True or false.

Definition at line 179 of file IngestJob.java.

References org.sleuthkit.autopsy.ingest.IngestJob.cancelled.

Member Data Documentation

volatile boolean org.sleuthkit.autopsy.ingest.IngestJob.cancelled
private
final Map<Long, DataSourceIngestJob> org.sleuthkit.autopsy.ingest.IngestJob.dataSourceJobs
private

Definition at line 42 of file IngestJob.java.

final long org.sleuthkit.autopsy.ingest.IngestJob.id
private

Definition at line 41 of file IngestJob.java.

Referenced by org.sleuthkit.autopsy.ingest.IngestJob.getId().

final AtomicInteger org.sleuthkit.autopsy.ingest.IngestJob.incompleteJobsCount
private

Definition at line 43 of file IngestJob.java.

final AtomicLong org.sleuthkit.autopsy.ingest.IngestJob.nextId = new AtomicLong(0L)
staticprivate

Definition at line 40 of file IngestJob.java.

boolean org.sleuthkit.autopsy.ingest.IngestJob.started
private

Definition at line 44 of file IngestJob.java.


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

Copyright © 2012-2015 Basis Technology. Generated on: Mon Oct 19 2015
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.