org.sleuthkit.autopsy.logicalimager.dsp.LogicalImagerDSProcessor Class Reference

Inherits org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor.

Public Member Functions
	LogicalImagerDSProcessor ()
void	cancel ()
String	getDataSourceType ()
JPanel	getPanel ()
boolean	isPanelValid ()
void	reset ()
void	run (DataSourceProcessorProgressMonitor progressMonitor, DataSourceProcessorCallback callback)
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 ()

Static Public Member Functions
static String	getType ()

Private Member Functions
void	run (String deviceId, String timeZone, File src, File dest, Host host, DataSourceProcessorProgressMonitor progressMonitor, DataSourceProcessorCallback callback) throws NoCurrentCaseException

Private Attributes
AddLogicalImageTask	addLogicalImageTask
final LogicalImagerPanel	configPanel

Static Private Attributes
static final String	LOGICAL_IMAGER_DIR = "LogicalImager"

Detailed Description

A Logical Imager data source processor that implements the DataSourceProcessor service provider interface to allow integration with the add data source wizard. It also provides a run method overload to allow it to be used independently of the wizard.

Definition at line 53 of file LogicalImagerDSProcessor.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.logicalimager.dsp.LogicalImagerDSProcessor.LogicalImagerDSProcessor

(

)

Definition at line 65 of file LogicalImagerDSProcessor.java.

Member Function Documentation

void org.sleuthkit.autopsy.logicalimager.dsp.LogicalImagerDSProcessor.cancel

(

)

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.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor.

Definition at line 251 of file LogicalImagerDSProcessor.java.

String org.sleuthkit.autopsy.logicalimager.dsp.LogicalImagerDSProcessor.getDataSourceType

(

)

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.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor.

Definition at line 89 of file LogicalImagerDSProcessor.java.

JPanel org.sleuthkit.autopsy.logicalimager.dsp.LogicalImagerDSProcessor.getPanel

(

)

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.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor.

Definition at line 102 of file LogicalImagerDSProcessor.java.

static String org.sleuthkit.autopsy.logicalimager.dsp.LogicalImagerDSProcessor.getType ( )

static

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.

Definition at line 77 of file LogicalImagerDSProcessor.java.

boolean org.sleuthkit.autopsy.logicalimager.dsp.LogicalImagerDSProcessor.isPanelValid

(

)

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.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor.

Definition at line 115 of file LogicalImagerDSProcessor.java.

void org.sleuthkit.autopsy.logicalimager.dsp.LogicalImagerDSProcessor.reset

(

)

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

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor.

Definition at line 262 of file LogicalImagerDSProcessor.java.

void org.sleuthkit.autopsy.logicalimager.dsp.LogicalImagerDSProcessor.run	(	DataSourceProcessorProgressMonitor	progressMonitor,
		DataSourceProcessorCallback	callback
	)

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.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor.

Definition at line 134 of file LogicalImagerDSProcessor.java.

void org.sleuthkit.autopsy.logicalimager.dsp.LogicalImagerDSProcessor.run	(	Host	host,
		DataSourceProcessorProgressMonitor	progressMonitor,
		DataSourceProcessorCallback	callback
	)

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

host	Host for 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.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor.

Definition at line 162 of file LogicalImagerDSProcessor.java.

References org.sleuthkit.autopsy.coreutils.TimeStampUtils.createTimeStamp(), org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessorCallback.DataSourceProcessorResult.CRITICAL_ERRORS, org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessorCallback.done(), org.sleuthkit.autopsy.casemodule.Case.getCurrentCase(), and org.sleuthkit.autopsy.casemodule.Case.getModuleDirectory().

void org.sleuthkit.autopsy.logicalimager.dsp.LogicalImagerDSProcessor.run ( String  deviceId, String  timeZone, File  src, File  dest, Host  host, DataSourceProcessorProgressMonitor  progressMonitor, DataSourceProcessorCallback  callback  ) throws NoCurrentCaseException

private

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

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).
timeZone	The time zone to use when processing dates and times for the image, obtained from java.util.TimeZone.getID.
src	The source directory of image.
dest	The destination directory to copy the source.
host	The host for this data source.
progressMonitor	Progress monitor for reporting progress during processing.
callback	Callback to call when processing is done.

Definition at line 240 of file LogicalImagerDSProcessor.java.

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

settings	The ingest job settings.
progress	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.

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

host	Host for this data source.
settings	The ingest job settings.
progress	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.

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.

Member Data Documentation

AddLogicalImageTask org.sleuthkit.autopsy.logicalimager.dsp.LogicalImagerDSProcessor.addLogicalImageTask

private

Definition at line 57 of file LogicalImagerDSProcessor.java.

final LogicalImagerPanel org.sleuthkit.autopsy.logicalimager.dsp.LogicalImagerDSProcessor.configPanel

private

Definition at line 56 of file LogicalImagerDSProcessor.java.

final String org.sleuthkit.autopsy.logicalimager.dsp.LogicalImagerDSProcessor.LOGICAL_IMAGER_DIR = "LogicalImager"

staticprivate

Definition at line 55 of file LogicalImagerDSProcessor.java.

---

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

• /home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/logicalimager/dsp/LogicalImagerDSProcessor.java