Autopsy  4.10.0
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

enum  CancellationReason
 
class  DataSourceIngestModuleHandle
 
class  ProgressSnapshot
 

Public Member Functions

void cancel ()
 
void cancel (CancellationReason reason)
 
CancellationReason getCancellationReason ()
 
long getId ()
 
ProgressSnapshot getSnapshot ()
 
ProgressSnapshot getSnapshot (boolean getIngestTasksSnapshot)
 
boolean isCancelled ()
 

Private Attributes

volatile CancellationReason cancellationReason
 
final Map< Long, DataSourceIngestJobdataSourceJobs
 
final long id
 
final AtomicInteger incompleteJobsCount
 

Static Private Attributes

static final AtomicLong nextId = new AtomicLong(0L)
 

Detailed Description

Analyzes one or more data sources using a set of ingest modules specified via ingest job settings.

Definition at line 39 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.

Deprecated:
Use cancel(CancellationReason reason) instead

Definition at line 219 of file IngestJob.java.

References org.sleuthkit.autopsy.ingest.IngestJob.CancellationReason.USER_CANCELLED.

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

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

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.

Parameters
reasonThe reason for cancellation.

Definition at line 231 of file IngestJob.java.

CancellationReason org.sleuthkit.autopsy.ingest.IngestJob.getCancellationReason ( )

Gets the reason this job was cancelled.

Returns
The cancellation reason, may be not cancelled.

Definition at line 243 of file IngestJob.java.

References org.sleuthkit.autopsy.ingest.IngestJob.cancellationReason.

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

Gets the unique identifier assigned to this ingest job.

Returns
The job identifier.

Definition at line 115 of file IngestJob.java.

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

Referenced by org.sleuthkit.autopsy.ingest.IngestManager.StartIngestJobTask.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 183 of file IngestJob.java.

Referenced by org.sleuthkit.autopsy.commandlineingest.CommandLineIngestManager.JobProcessingTask.analyze().

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 192 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 253 of file IngestJob.java.

References org.sleuthkit.autopsy.ingest.IngestJob.CancellationReason.NOT_CANCELLED.

Member Data Documentation

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

Definition at line 66 of file IngestJob.java.

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

Definition at line 65 of file IngestJob.java.

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

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

Definition at line 67 of file IngestJob.java.

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

Definition at line 64 of file IngestJob.java.


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

Copyright © 2012-2018 Basis Technology. Generated on: Fri Mar 22 2019
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.