Autopsy  4.19.3
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 (IngestJobExecutor ingestJobExecutor, DataSourceIngestPipeline.DataSourcePipelineModule module)
 

Private Attributes

final boolean cancelled
 
final IngestJobExecutor ingestJobExecutor
 
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 551 of file IngestJob.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.ingest.IngestJob.DataSourceIngestModuleHandle.DataSourceIngestModuleHandle ( IngestJobExecutor  ingestJobExecutor,
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
ingestJobExecutorThe ingest job executor that owns the data source level ingest module.
moduleThe data source level ingest module.

Definition at line 566 of file IngestJob.java.

References org.sleuthkit.autopsy.ingest.IngestJob.DataSourceIngestModuleHandle.ingestJobExecutor, 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.

Definition at line 607 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 578 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 598 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 588 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 IngestJobExecutor org.sleuthkit.autopsy.ingest.IngestJob.DataSourceIngestModuleHandle.ingestJobExecutor
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-2022 Basis Technology. Generated on: Thu Oct 6 2022
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.