Autopsy  4.18.0
Graphical digital forensics platform for The Sleuth Kit and other tools.
Public Member Functions | Private Member Functions | Private Attributes | List of all members
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.DataSourcePipelineModule module)
 

Private Attributes

final boolean cancelled
 
final IngestJobPipeline ingestJobPipeline
 
final DataSourceIngestPipeline.DataSourcePipelineModule 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 511 of file IngestJob.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.ingest.IngestJob.DataSourceIngestModuleHandle.DataSourceIngestModuleHandle ( IngestJobPipeline  ingestJobPipeline,
DataSourceIngestPipeline.DataSourcePipelineModule  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
ingestJobPipelineThe ingestJobPipeline that owns the data source level ingest module.
moduleThe data source level ingest module.

Definition at line 526 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 567 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 538 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 558 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 548 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
final IngestJobPipeline org.sleuthkit.autopsy.ingest.IngestJob.DataSourceIngestModuleHandle.ingestJobPipeline
private
final DataSourceIngestPipeline.DataSourcePipelineModule org.sleuthkit.autopsy.ingest.IngestJob.DataSourceIngestModuleHandle.module
private

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

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