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, and org.sleuthkit.autopsy.datasourceprocessors.RawDSProcessor.

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)
void	reset ()
void	run (DataSourceProcessorProgressMonitor progressMonitor, DataSourceProcessorCallback callback)

Detailed Description

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

Author

elivis

Definition at line 32 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.LocalFilesDSProcessor, org.sleuthkit.autopsy.casemodule.ImageDSProcessor, org.sleuthkit.autopsy.logicalimager.dsp.LogicalImagerDSProcessor, org.sleuthkit.autopsy.casemodule.LocalDiskDSProcessor, 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

dataSourcePath

Path 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.LocalFilesDSProcessor, org.sleuthkit.autopsy.casemodule.ImageDSProcessor, and org.sleuthkit.autopsy.datasourceprocessors.RawDSProcessor.

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.logicalimager.dsp.LogicalImagerDSProcessor, and org.sleuthkit.autopsy.casemodule.LocalDiskDSProcessor.

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.logicalimager.dsp.LogicalImagerDSProcessor, and org.sleuthkit.autopsy.casemodule.LocalDiskDSProcessor.

boolean org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor.isPanelValid ( )

inherited

Indicates whether the settings in the selection and configuration panel are valid and complete.

Returns

True if the settings are valid and complete and the processor is ready to have its run method called, false otherwise.

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

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

deviceId	An ASCII-printable identifier for the device associated with the data source that is intended to be unique across multiple cases (e.g., a UUID).
dataSourcePath	Path to the data source.
progressMonitor	Progress monitor that will be used by the background task to report progress.
callBack	Callback that will be used by the background task to return results.

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

void org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor.reset ( )

inherited

Resets the selection and configuration panel for this data source processor.

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

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

progressMonitor	Progress monitor that will be used by the background task to report progress.
callback	Callback 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.logicalimager.dsp.LogicalImagerDSProcessor, org.sleuthkit.autopsy.datasourceprocessors.RawDSProcessor, and org.sleuthkit.autopsy.casemodule.LocalDiskDSProcessor.

---

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

• /home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/datasourceprocessors/AutoIngestDataSourceProcessor.java