Autopsy  4.19.3
Graphical digital forensics platform for The Sleuth Kit and other tools.
Classes | Public Member Functions | List of all members
org.sleuthkit.autopsy.datasourceprocessors.AutoIngestDataSourceProcessor Interface Reference

Inherits org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor.

Inherited by org.sleuthkit.autopsy.casemodule.ImageDSProcessor, org.sleuthkit.autopsy.casemodule.LocalFilesDSProcessor, org.sleuthkit.autopsy.datasourceprocessors.RawDSProcessor, and org.sleuthkit.autopsy.datasourceprocessors.xry.XRYDataSourceProcessor.

Classes

class  AutoIngestDataSourceProcessorException
 

Public Member Functions

void cancel ()
 
int canProcess (Path dataSourcePath) throws AutoIngestDataSourceProcessorException
 
String getDataSourceType ()
 
JPanel getPanel ()
 
boolean isPanelValid ()
 
void process (String deviceId, Path dataSourcePath, DataSourceProcessorProgressMonitor progressMonitor, DataSourceProcessorCallback callBack)
 
default void process (String deviceId, Path dataSourcePath, Host host, DataSourceProcessorProgressMonitor progressMonitor, DataSourceProcessorCallback callBack)
 
default IngestStream processWithIngestStream (String deviceId, Path dataSourcePath, IngestJobSettings settings, DataSourceProcessorProgressMonitor progressMonitor, DataSourceProcessorCallback callBack)
 
default IngestStream processWithIngestStream (String deviceId, Path dataSourcePath, Host host, IngestJobSettings settings, DataSourceProcessorProgressMonitor progressMonitor, DataSourceProcessorCallback callBack)
 
void reset ()
 
void run (DataSourceProcessorProgressMonitor progressMonitor, DataSourceProcessorCallback callback)
 
default void run (Host host, DataSourceProcessorProgressMonitor progressMonitor, DataSourceProcessorCallback callback)
 
default void runWithIngestStream (IngestJobSettings settings, DataSourceProcessorProgressMonitor progress, DataSourceProcessorCallback callBack)
 
default void runWithIngestStream (Host host, IngestJobSettings settings, DataSourceProcessorProgressMonitor progress, DataSourceProcessorCallback callBack)
 
default boolean supportsIngestStream ()
 

Detailed Description

Interface implemented by DataSourceProcessors in order to be supported by automated ingest capability.

Author
elivis

Definition at line 35 of file AutoIngestDataSourceProcessor.java.

Member Function Documentation

void org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor.cancel ( )
inherited

Requests cancellation of the background task that adds a data source to the case database, after the task is started using the run method. This is a "best effort" cancellation, with no guarantees that the case database will be unchanged. If cancellation succeeded, the list of new data sources returned by the background task will be empty.

Implemented in org.sleuthkit.autopsy.casemodule.ImageDSProcessor, org.sleuthkit.autopsy.casemodule.LocalFilesDSProcessor, org.sleuthkit.autopsy.datasourceprocessors.xry.XRYDataSourceProcessor, org.sleuthkit.autopsy.casemodule.LocalDiskDSProcessor, org.sleuthkit.autopsy.logicalimager.dsp.LogicalImagerDSProcessor, and org.sleuthkit.autopsy.datasourceprocessors.RawDSProcessor.

int org.sleuthkit.autopsy.datasourceprocessors.AutoIngestDataSourceProcessor.canProcess ( Path  dataSourcePath) throws AutoIngestDataSourceProcessorException

Indicates whether the DataSourceProcessor is capable of processing the data source. Returns a confidence value. Method can throw an exception for a system level problem. The exception should not be thrown for an issue related to bad input data.

Parameters
dataSourcePathPath to the data source.
Returns
Confidence value. Values between 0 and 100 are recommended. Zero or less means the data source is not supported by the DataSourceProcessor. Value of 100 indicates high certainty in being able to process the data source.
Exceptions
org.sleuthkit.autopsy.datasourceprocessors.AutoIngestDataSourceProcessor.AutoIngestDataSourceProcessorException

Implemented in org.sleuthkit.autopsy.casemodule.ImageDSProcessor, org.sleuthkit.autopsy.casemodule.LocalFilesDSProcessor, org.sleuthkit.autopsy.datasourceprocessors.RawDSProcessor, and org.sleuthkit.autopsy.datasourceprocessors.xry.XRYDataSourceProcessor.

String org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor.getDataSourceType ( )
inherited

Gets a string that describes the type of data sources this processor is able to add to the case database. The string is suitable for display in a type selection UI component (e.g., a combo box).

Returns
A data source type display string for this data source processor.

Implemented in org.sleuthkit.autopsy.casemodule.ImageDSProcessor, org.sleuthkit.autopsy.casemodule.LocalFilesDSProcessor, org.sleuthkit.autopsy.datasourceprocessors.RawDSProcessor, org.sleuthkit.autopsy.casemodule.LocalDiskDSProcessor, org.sleuthkit.autopsy.logicalimager.dsp.LogicalImagerDSProcessor, org.sleuthkit.autopsy.datasourceprocessors.xry.XRYDataSourceProcessor, and org.sleuthkit.autopsy.datasourceprocessors.DataSourceProcessorAdapter.

JPanel org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor.getPanel ( )
inherited

Gets the panel that allows a user to select a data source and do any configuration required by the data source. The panel is less than 544 pixels wide and less than 173 pixels high.

Returns
A selection and configuration panel for this data source processor.

Implemented in org.sleuthkit.autopsy.casemodule.ImageDSProcessor, org.sleuthkit.autopsy.casemodule.LocalFilesDSProcessor, org.sleuthkit.autopsy.datasourceprocessors.RawDSProcessor, org.sleuthkit.autopsy.casemodule.LocalDiskDSProcessor, org.sleuthkit.autopsy.logicalimager.dsp.LogicalImagerDSProcessor, org.sleuthkit.autopsy.datasourceprocessors.xry.XRYDataSourceProcessor, and org.sleuthkit.autopsy.datasourceprocessors.DataSourceProcessorAdapter.

boolean org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor.isPanelValid ( )
inherited
void org.sleuthkit.autopsy.datasourceprocessors.AutoIngestDataSourceProcessor.process ( String  deviceId,
Path  dataSourcePath,
DataSourceProcessorProgressMonitor  progressMonitor,
DataSourceProcessorCallback  callBack 
)

Adds a data source to the case database using a background task in a separate thread by calling DataSourceProcessor.run() method. Returns as soon as the background task is started. The background task uses a callback object to signal task completion and return results. Method can throw an exception for a system level problem. The exception should not be thrown for an issue related to bad input data.

Parameters
deviceIdAn ASCII-printable identifier for the device associated with the data source that is intended to be unique across multiple cases (e.g., a UUID).
dataSourcePathPath to the data source.
progressMonitorProgress monitor that will be used by the background task to report progress.
callBackCallback that will be used by the background task to return results.

Implemented in org.sleuthkit.autopsy.casemodule.ImageDSProcessor, org.sleuthkit.autopsy.casemodule.LocalFilesDSProcessor, org.sleuthkit.autopsy.datasourceprocessors.xry.XRYDataSourceProcessor, and org.sleuthkit.autopsy.datasourceprocessors.RawDSProcessor.

Referenced by org.sleuthkit.autopsy.datasourceprocessors.AutoIngestDataSourceProcessor.process().

default void org.sleuthkit.autopsy.datasourceprocessors.AutoIngestDataSourceProcessor.process ( String  deviceId,
Path  dataSourcePath,
Host  host,
DataSourceProcessorProgressMonitor  progressMonitor,
DataSourceProcessorCallback  callBack 
)

Adds a data source to the case database using a background task in a separate thread by calling DataSourceProcessor.run() method. Returns as soon as the background task is started. The background task uses a callback object to signal task completion and return results. Method can throw an exception for a system level problem. The exception should not be thrown for an issue related to bad input data.

Parameters
deviceIdAn ASCII-printable identifier for the device associated with the data source that is intended to be unique across multiple cases (e.g., a UUID).
dataSourcePathPath to the data source.
hostHost for this data source.
progressMonitorProgress monitor that will be used by the background task to report progress.
callBackCallback that will be used by the background task to return results.

Implemented in org.sleuthkit.autopsy.casemodule.ImageDSProcessor, org.sleuthkit.autopsy.casemodule.LocalFilesDSProcessor, org.sleuthkit.autopsy.datasourceprocessors.xry.XRYDataSourceProcessor, and org.sleuthkit.autopsy.datasourceprocessors.RawDSProcessor.

Definition at line 90 of file AutoIngestDataSourceProcessor.java.

References org.sleuthkit.autopsy.datasourceprocessors.AutoIngestDataSourceProcessor.process().

default IngestStream org.sleuthkit.autopsy.datasourceprocessors.AutoIngestDataSourceProcessor.processWithIngestStream ( String  deviceId,
Path  dataSourcePath,
IngestJobSettings  settings,
DataSourceProcessorProgressMonitor  progressMonitor,
DataSourceProcessorCallback  callBack 
)

Adds a data source to the case database using a background task in a separate thread by calling DataSourceProcessor.run() method. Returns as soon as the background task is started. The background task uses a callback object to signal task completion and return results. Method can throw an exception for a system level problem. The exception should not be thrown for an issue related to bad input data.

Parameters
deviceIdAn ASCII-printable identifier for the device associated with the data source that is intended to be unique across multiple cases (e.g., a UUID).
dataSourcePathPath to the data source.
settingsThe ingest job settings.
progressMonitorProgress monitor that will be used by the background task to report progress.
callBackCallback that will be used by the background task to return results.
Returns
The new ingest stream or null if an error occurred. Errors will be handled by the callback.

Implemented in org.sleuthkit.autopsy.casemodule.ImageDSProcessor.

Definition at line 114 of file AutoIngestDataSourceProcessor.java.

Referenced by org.sleuthkit.autopsy.datasourceprocessors.AutoIngestDataSourceProcessor.processWithIngestStream().

default IngestStream org.sleuthkit.autopsy.datasourceprocessors.AutoIngestDataSourceProcessor.processWithIngestStream ( String  deviceId,
Path  dataSourcePath,
Host  host,
IngestJobSettings  settings,
DataSourceProcessorProgressMonitor  progressMonitor,
DataSourceProcessorCallback  callBack 
)

Adds a data source to the case database using a background task in a separate thread by calling DataSourceProcessor.run() method. Returns as soon as the background task is started. The background task uses a callback object to signal task completion and return results. Method can throw an exception for a system level problem. The exception should not be thrown for an issue related to bad input data.

Parameters
deviceIdAn ASCII-printable identifier for the device associated with the data source that is intended to be unique across multiple cases (e.g., a UUID).
dataSourcePathPath to the data source.
hostThe host for this data source.
settingsThe ingest job settings.
progressMonitorProgress monitor that will be used by the background task to report progress.
callBackCallback that will be used by the background task to return results.
Returns
The new ingest stream or null if an error occurred. Errors will be handled by the callback.

Implemented in org.sleuthkit.autopsy.casemodule.ImageDSProcessor.

Definition at line 139 of file AutoIngestDataSourceProcessor.java.

References org.sleuthkit.autopsy.datasourceprocessors.AutoIngestDataSourceProcessor.processWithIngestStream().

void org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor.reset ( )
inherited
void org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor.run ( DataSourceProcessorProgressMonitor  progressMonitor,
DataSourceProcessorCallback  callback 
)
inherited

Adds a data source to the case database using a background task in a separate thread and the settings provided by the selection and configuration panel. Returns as soon as the background task is started. The background task uses a callback object to signal task completion and return results.

This method should not be called unless isPanelValid returns true.

Parameters
progressMonitorProgress monitor that will be used by the background task to report progress.
callbackCallback that will be used by the background task to return results.

Implemented in org.sleuthkit.autopsy.datasourceprocessors.xry.XRYDataSourceProcessor, org.sleuthkit.autopsy.casemodule.ImageDSProcessor, org.sleuthkit.autopsy.casemodule.LocalFilesDSProcessor, org.sleuthkit.autopsy.datasourceprocessors.RawDSProcessor, org.sleuthkit.autopsy.casemodule.LocalDiskDSProcessor, and org.sleuthkit.autopsy.logicalimager.dsp.LogicalImagerDSProcessor.

Referenced by org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor.run().

default void org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor.run ( Host  host,
DataSourceProcessorProgressMonitor  progressMonitor,
DataSourceProcessorCallback  callback 
)
inherited

Adds a data source to the case database using a background task in a separate thread and the settings provided by the selection and configuration panel. Returns as soon as the background task is started. The background task uses a callback object to signal task completion and return results.

This method should not be called unless isPanelValid returns true.

Parameters
hostHost for the data source.
progressMonitorProgress monitor that will be used by the background task to report progress.
callbackCallback that will be used by the background task to return results.

Implemented in org.sleuthkit.autopsy.datasourceprocessors.xry.XRYDataSourceProcessor, org.sleuthkit.autopsy.casemodule.ImageDSProcessor, org.sleuthkit.autopsy.casemodule.LocalFilesDSProcessor, org.sleuthkit.autopsy.logicalimager.dsp.LogicalImagerDSProcessor, org.sleuthkit.autopsy.datasourceprocessors.RawDSProcessor, org.sleuthkit.autopsy.casemodule.LocalDiskDSProcessor, and org.sleuthkit.autopsy.datasourceprocessors.DataSourceProcessorAdapter.

Definition at line 128 of file DataSourceProcessor.java.

References org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor.run().

default void org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor.runWithIngestStream ( IngestJobSettings  settings,
DataSourceProcessorProgressMonitor  progress,
DataSourceProcessorCallback  callBack 
)
inherited

Adds a data source to the case database using a background task in a separate thread and the settings provided by the selection and configuration panel. Files found during ingest will be sent directly to the IngestStream provided. Returns as soon as the background task is started. The background task uses a callback object to signal task completion and return results.

This method should not be called unless isPanelValid returns true, and should only be called for DSPs that support ingest streams. The ingest settings must be complete before calling this method.

Parameters
settingsThe ingest job settings.
progressProgress monitor that will be used by the background task to report progress.
callBackCallback that will be used by the background task to return results.

Implemented in org.sleuthkit.autopsy.casemodule.ImageDSProcessor.

Definition at line 150 of file DataSourceProcessor.java.

Referenced by org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor.runWithIngestStream().

default void org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor.runWithIngestStream ( Host  host,
IngestJobSettings  settings,
DataSourceProcessorProgressMonitor  progress,
DataSourceProcessorCallback  callBack 
)
inherited

Adds a data source to the case database using a background task in a separate thread and the settings provided by the selection and configuration panel. Files found during ingest will be sent directly to the IngestStream provided. Returns as soon as the background task is started. The background task uses a callback object to signal task completion and return results.

This method should not be called unless isPanelValid returns true, and should only be called for DSPs that support ingest streams. The ingest settings must be complete before calling this method.

Parameters
hostHost for this data source.
settingsThe ingest job settings.
progressProgress monitor that will be used by the background task to report progress.
callBackCallback that will be used by the background task to return results.

Implemented in org.sleuthkit.autopsy.casemodule.ImageDSProcessor.

Definition at line 174 of file DataSourceProcessor.java.

References org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor.runWithIngestStream().

default boolean org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor.supportsIngestStream ( )
inherited

Check if this DSP supports ingest streams.

Returns
True if this DSP supports an ingest stream, false otherwise.

Implemented in org.sleuthkit.autopsy.casemodule.ImageDSProcessor.

Definition at line 184 of file DataSourceProcessor.java.


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

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