Autopsy  4.19.3
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
 
enum  Mode
 
class  ProgressSnapshot
 

Public Member Functions

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

Private Attributes

volatile CancellationReason cancellationReason
 
final DataSource dataSource
 
final List< AbstractFile > files = new ArrayList<>()
 
final long id
 
final Mode ingestMode
 
volatile IngestJobExecutor ingestModuleExecutor
 
final IngestJobSettings settings
 

Static Private Attributes

static final Logger logger = Logger.getLogger(IngestJob.class.getName())
 
static final AtomicLong nextId = new AtomicLong(0L)
 

Detailed Description

Analyzes a 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 module 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 300 of file IngestJob.java.

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

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

Requests cancellation of this ingest job, which means discarding unfinished tasks and stopping the ingest module 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 312 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 335 of file IngestJob.java.

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

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

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

Gets the unique identifier assigned to this ingest job. For a multi-user case, this ID is only unique on the host where the ingest job is running.

Returns
The job identifier.

Definition at line 120 of file IngestJob.java.

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

Referenced by org.sleuthkit.autopsy.ingest.IngestManager.StartIngestJobTask.call().

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

Gets a snapshot of the progress of this ingest job.

Returns
The snapshot, will be null if the job is not started yet.

Definition at line 258 of file IngestJob.java.

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

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

Gets a snapshot of the progress of this ingest job.

Parameters
includeIngestTasksSnapshotWhether or not to include ingest task stats in the snapshot.
Returns
The snapshot, will be null if the job is not started yet.

Definition at line 270 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 345 of file IngestJob.java.

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

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

Member Data Documentation

volatile CancellationReason org.sleuthkit.autopsy.ingest.IngestJob.cancellationReason
private
final DataSource org.sleuthkit.autopsy.ingest.IngestJob.dataSource
private

Definition at line 75 of file IngestJob.java.

final List<AbstractFile> org.sleuthkit.autopsy.ingest.IngestJob.files = new ArrayList<>()
private

Definition at line 76 of file IngestJob.java.

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

Definition at line 74 of file IngestJob.java.

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

final Mode org.sleuthkit.autopsy.ingest.IngestJob.ingestMode
private

Definition at line 77 of file IngestJob.java.

volatile IngestJobExecutor org.sleuthkit.autopsy.ingest.IngestJob.ingestModuleExecutor
private

Definition at line 79 of file IngestJob.java.

final Logger org.sleuthkit.autopsy.ingest.IngestJob.logger = Logger.getLogger(IngestJob.class.getName())
staticprivate

Definition at line 72 of file IngestJob.java.

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

Definition at line 73 of file IngestJob.java.

final IngestJobSettings org.sleuthkit.autopsy.ingest.IngestJob.settings
private

Definition at line 78 of file IngestJob.java.


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

Copyright © 2012-2022 Basis Technology. Generated on: Thu Sep 29 2022
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.