org.sleuthkit.autopsy.datasourceprocessors.DataSourceProcessorAdapter Class Reference

Inherits org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor.

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

An adapter that provides no-op implementations of various DataSourceProcessor methods.

Definition at line 34 of file DataSourceProcessorAdapter.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.

abstract String org.sleuthkit.autopsy.datasourceprocessors.DataSourceProcessorAdapter.getDataSourceType ( )

abstract

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.

JPanel org.sleuthkit.autopsy.datasourceprocessors.DataSourceProcessorAdapter.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 39 of file DataSourceProcessorAdapter.java.

boolean org.sleuthkit.autopsy.datasourceprocessors.DataSourceProcessorAdapter.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 44 of file DataSourceProcessorAdapter.java.

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.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.

void org.sleuthkit.autopsy.datasourceprocessors.DataSourceProcessorAdapter.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 49 of file DataSourceProcessorAdapter.java.

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.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.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.

---

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

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