org.sleuthkit.autopsy.ingest.IngestJob.ProgressSnapshot Class Reference

Classes
class	DataSourceProcessingSnapshot

Public Member Functions
boolean	fileIngestIsRunning ()
Date	fileIngestStartTime ()
CancellationReason	getCancellationReason ()
DataSourceProcessingSnapshot	getDataSourceProcessingSnapshot ()
boolean	isCancelled ()
DataSourceIngestModuleHandle	runningDataSourceIngestModule ()

Private Member Functions
	ProgressSnapshot (boolean includeIngestTasksSnapshot)

Private Attributes
final DataSourceProcessingSnapshot	dataSourceProcessingSnapshot
final CancellationReason	jobCancellationReason
final boolean	jobCancellationRequested

Detailed Description

A snapshot of the progress of an ingest job.

Definition at line 366 of file IngestJob.java.

Constructor & Destructor Documentation

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

private

Constructs a snapshot of the progress of an ingest job.

Parameters

includeIngestTasksSnapshot

Whether or not to include ingest task stats in basic diagnostic stats part of the snapshot.

Definition at line 472 of file IngestJob.java.

References org.sleuthkit.autopsy.ingest.IngestJob.getCancellationReason(), and org.sleuthkit.autopsy.ingest.IngestJob.isCancelled().

Member Function Documentation

boolean org.sleuthkit.autopsy.ingest.IngestJob.ProgressSnapshot.fileIngestIsRunning

(

)

Queries whether or not file level ingest was running at the time the snapshot was taken.

Returns

True or false.

Definition at line 501 of file IngestJob.java.

References org.sleuthkit.autopsy.ingest.IngestJob.ProgressSnapshot.DataSourceProcessingSnapshot.fileIngestIsRunning().

Date org.sleuthkit.autopsy.ingest.IngestJob.ProgressSnapshot.fileIngestStartTime

(

)

Gets the time that file level ingest started.

Returns

The start time, may be null.

Definition at line 510 of file IngestJob.java.

References org.sleuthkit.autopsy.ingest.IngestJob.ProgressSnapshot.DataSourceProcessingSnapshot.fileIngestStartTime().

CancellationReason org.sleuthkit.autopsy.ingest.IngestJob.ProgressSnapshot.getCancellationReason

(

)

Gets the reason the ingest job was cancelled.

Returns

The cancellation reason, which may indicate that the job had not been cancelled at the time the snapshot was taken.

Definition at line 530 of file IngestJob.java.

References org.sleuthkit.autopsy.ingest.IngestJob.ProgressSnapshot.jobCancellationReason.

DataSourceProcessingSnapshot org.sleuthkit.autopsy.ingest.IngestJob.ProgressSnapshot.getDataSourceProcessingSnapshot

(

)

Gets a snapshot of some basic diagnostic statistics for an ingest job.

Returns

The snapshot.

Definition at line 540 of file IngestJob.java.

References org.sleuthkit.autopsy.ingest.IngestJob.ProgressSnapshot.dataSourceProcessingSnapshot.

boolean org.sleuthkit.autopsy.ingest.IngestJob.ProgressSnapshot.isCancelled

(

)

Queries whether or not an ingest job cancellation request had been issued at the time the snapshot was taken.

Returns

True or false.

Definition at line 520 of file IngestJob.java.

References org.sleuthkit.autopsy.ingest.IngestJob.ProgressSnapshot.jobCancellationRequested.

DataSourceIngestModuleHandle org.sleuthkit.autopsy.ingest.IngestJob.ProgressSnapshot.runningDataSourceIngestModule

(

)

Gets a handle to the currently running data source level ingest module at the time the snapshot was taken. This handle can be used to cancel the module, if it is still running.

Returns

The handle, may be null.

Definition at line 486 of file IngestJob.java.

Member Data Documentation

final DataSourceProcessingSnapshot org.sleuthkit.autopsy.ingest.IngestJob.ProgressSnapshot.dataSourceProcessingSnapshot

private

Definition at line 368 of file IngestJob.java.

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

final CancellationReason org.sleuthkit.autopsy.ingest.IngestJob.ProgressSnapshot.jobCancellationReason

private

Definition at line 370 of file IngestJob.java.

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

final boolean org.sleuthkit.autopsy.ingest.IngestJob.ProgressSnapshot.jobCancellationRequested

private

Definition at line 369 of file IngestJob.java.

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

---

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

• /home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/ingest/IngestJob.java