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

Public Member Functions
void	cancel ()
String	displayName ()
boolean	isCancelled ()
Date	startTime ()

Private Member Functions
	DataSourceIngestModuleHandle (IngestJobPipeline ingestJobPipeline, DataSourceIngestPipeline.PipelineModule module)

Private Attributes
final boolean	cancelled
final IngestJobPipeline	ingestJobPipeline
final DataSourceIngestPipeline.PipelineModule	module

Detailed Description

A handle to a data source level ingest module that can be used to get basic information about the module and to request cancellation of the module.

Definition at line 500 of file IngestJob.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.ingest.IngestJob.DataSourceIngestModuleHandle.DataSourceIngestModuleHandle ( IngestJobPipeline  ingestJobPipeline, DataSourceIngestPipeline.PipelineModule  module  )

private

Constructs a handle to a data source level ingest module that can be used to get basic information about the module and to request cancellation of the module.

Parameters

ingestJobPipeline	The ingestJobPipeline that owns the data source level ingest module.
module	The data source level ingest module.

Definition at line 514 of file IngestJob.java.

References org.sleuthkit.autopsy.ingest.IngestJob.DataSourceIngestModuleHandle.ingestJobPipeline, and org.sleuthkit.autopsy.ingest.IngestJob.DataSourceIngestModuleHandle.module.

Member Function Documentation

void org.sleuthkit.autopsy.ingest.IngestJob.DataSourceIngestModuleHandle.cancel

(

)

Requests cancellation of the ingest module associated with this handle. Returns immediately, but there may be a delay before the ingest module responds by stopping processing.

TODO: Cancellation needs to be more precise. The long-term solution is to add a cancel() method to IngestModule and do away with the cancellation queries of IngestJobContext. However, until an API change is legal, a cancel() method can be added to the DataSourceIngestModuleAdapter and FileIngestModuleAdapter classes and an instanceof check can be used to call it, with this code as the default implementation and the fallback. All of the ingest modules participating in this workaround will need to consult the cancelled flag in the adapters.

Definition at line 555 of file IngestJob.java.

References org.sleuthkit.autopsy.ingest.IngestJob.DataSourceIngestModuleHandle.module.

String org.sleuthkit.autopsy.ingest.IngestJob.DataSourceIngestModuleHandle.displayName

(

)

Gets the display name of the data source level ingest module associated with this handle.

Returns

The display name.

Definition at line 526 of file IngestJob.java.

References org.sleuthkit.autopsy.ingest.IngestJob.DataSourceIngestModuleHandle.module.

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

(

)

Queries whether or not cancellation of the data source level ingest module associated with this handle has been requested.

Returns

True or false.

Definition at line 546 of file IngestJob.java.

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

Date org.sleuthkit.autopsy.ingest.IngestJob.DataSourceIngestModuleHandle.startTime

(

)

Gets the time the data source level ingest module associated with this handle began processing.

Returns

The module processing start time.

Definition at line 536 of file IngestJob.java.

References org.sleuthkit.autopsy.ingest.IngestJob.DataSourceIngestModuleHandle.module.

Member Data Documentation

final boolean org.sleuthkit.autopsy.ingest.IngestJob.DataSourceIngestModuleHandle.cancelled

private

Definition at line 504 of file IngestJob.java.

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

final IngestJobPipeline org.sleuthkit.autopsy.ingest.IngestJob.DataSourceIngestModuleHandle.ingestJobPipeline

private

Definition at line 502 of file IngestJob.java.

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

final DataSourceIngestPipeline.PipelineModule org.sleuthkit.autopsy.ingest.IngestJob.DataSourceIngestModuleHandle.module

private

Definition at line 503 of file IngestJob.java.

Referenced by org.sleuthkit.autopsy.ingest.IngestJob.DataSourceIngestModuleHandle.cancel(), org.sleuthkit.autopsy.ingest.IngestJob.DataSourceIngestModuleHandle.DataSourceIngestModuleHandle(), org.sleuthkit.autopsy.ingest.IngestJob.DataSourceIngestModuleHandle.displayName(), and org.sleuthkit.autopsy.ingest.IngestJob.DataSourceIngestModuleHandle.startTime().

---

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

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