org.sleuthkit.autopsy.datasourceprocessors.xry.XRYDataSourceProcessor Class Reference

Inherits org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor, and org.sleuthkit.autopsy.datasourceprocessors.AutoIngestDataSourceProcessor.

Classes
class	XRYReportProcessorSwingWorker

Public Member Functions
	XRYDataSourceProcessor ()
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	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)
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 ()

Private Attributes
final XRYDataSourceProcessorConfigPanel	configPanel
XRYReportProcessorSwingWorker	swingWorker

Static Private Attributes
static final Logger	logger = Logger.getLogger(XRYDataSourceProcessor.class.getName())
static final int	XRY_FILES_DEPTH = 1

Detailed Description

An XRY Report data source processor.

Definition at line 64 of file XRYDataSourceProcessor.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.datasourceprocessors.xry.XRYDataSourceProcessor.XRYDataSourceProcessor

(

)

Definition at line 76 of file XRYDataSourceProcessor.java.

Member Function Documentation

void org.sleuthkit.autopsy.datasourceprocessors.xry.XRYDataSourceProcessor.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 281 of file XRYDataSourceProcessor.java.

int org.sleuthkit.autopsy.datasourceprocessors.xry.XRYDataSourceProcessor.canProcess

(

Path

dataSourcePath

)

throws AutoIngestDataSourceProcessorException

Tests if the given path is an XRY Folder.

This function assumes the calling thread has sufficient privileges to read the folder and its child content.

Parameters

dataSourcePath

Path to test

Returns

100 if the folder passes the XRY Folder check, 0 otherwise.

Exceptions

AutoIngestDataSourceProcessorException

if an I/O error occurs during disk reads.

Implements org.sleuthkit.autopsy.datasourceprocessors.AutoIngestDataSourceProcessor.

Definition at line 176 of file XRYDataSourceProcessor.java.

String org.sleuthkit.autopsy.datasourceprocessors.xry.XRYDataSourceProcessor.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 84 of file XRYDataSourceProcessor.java.

JPanel org.sleuthkit.autopsy.datasourceprocessors.xry.XRYDataSourceProcessor.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 89 of file XRYDataSourceProcessor.java.

boolean org.sleuthkit.autopsy.datasourceprocessors.xry.XRYDataSourceProcessor.isPanelValid

(

)

Tests the selected path.

This functions checks permissions to the path directly and then to each of its top most children, if it is a folder.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor.

Definition at line 108 of file XRYDataSourceProcessor.java.

void org.sleuthkit.autopsy.datasourceprocessors.xry.XRYDataSourceProcessor.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.

Implements org.sleuthkit.autopsy.datasourceprocessors.AutoIngestDataSourceProcessor.

Definition at line 243 of file XRYDataSourceProcessor.java.

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

Processes the XRY Folder encountered in an auto-ingest context. The heavy lifting is done off of the EDT, so this function will return while the path is still being processed.

This function assumes the calling thread has sufficient privileges to read the folder and its child content.

Parameters

deviceId
dataSourcePath
host
progressMonitor
callBack

Implements org.sleuthkit.autopsy.datasourceprocessors.AutoIngestDataSourceProcessor.

Definition at line 262 of file XRYDataSourceProcessor.java.

References org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessorCallback.DataSourceProcessorResult.CRITICAL_ERRORS, org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessorCallback.done(), org.sleuthkit.autopsy.casemodule.Case.getCurrentCaseThrows(), and org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessorProgressMonitor.setIndeterminate().

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

inherited

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

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  )

inherited

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

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.datasourceprocessors.xry.XRYDataSourceProcessor.reset

(

)

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

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor.

Definition at line 288 of file XRYDataSourceProcessor.java.

void org.sleuthkit.autopsy.datasourceprocessors.xry.XRYDataSourceProcessor.run	(	DataSourceProcessorProgressMonitor	progressMonitor,
		DataSourceProcessorCallback	callback
	)

Processes the XRY folder that the examiner selected. The heavy lifting is done off of the EDT, so this function will return while the path is still being processed.

This function assumes the calling thread has sufficient privileges to read the folder and its child content, which should have been validated in isPanelValid().

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor.

Definition at line 197 of file XRYDataSourceProcessor.java.

void org.sleuthkit.autopsy.datasourceprocessors.xry.XRYDataSourceProcessor.run	(	Host	host,
		DataSourceProcessorProgressMonitor	progressMonitor,
		DataSourceProcessorCallback	callback
	)

Processes the XRY folder that the examiner selected. The heavy lifting is done off of the EDT, so this function will return while the path is still being processed.

This function assumes the calling thread has sufficient privileges to read the folder and its child content, which should have been validated in isPanelValid().

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 220 of file XRYDataSourceProcessor.java.

References org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessorCallback.DataSourceProcessorResult.CRITICAL_ERRORS, org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessorCallback.done(), org.sleuthkit.autopsy.casemodule.Case.getCurrentCaseThrows(), and org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessorProgressMonitor.setIndeterminate().

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

final XRYDataSourceProcessorConfigPanel org.sleuthkit.autopsy.datasourceprocessors.xry.XRYDataSourceProcessor.configPanel

private

Definition at line 66 of file XRYDataSourceProcessor.java.

final Logger org.sleuthkit.autopsy.datasourceprocessors.xry.XRYDataSourceProcessor.logger = Logger.getLogger(XRYDataSourceProcessor.class.getName())

staticprivate

Definition at line 74 of file XRYDataSourceProcessor.java.

XRYReportProcessorSwingWorker org.sleuthkit.autopsy.datasourceprocessors.xry.XRYDataSourceProcessor.swingWorker

private

Definition at line 72 of file XRYDataSourceProcessor.java.

final int org.sleuthkit.autopsy.datasourceprocessors.xry.XRYDataSourceProcessor.XRY_FILES_DEPTH = 1

staticprivate

Definition at line 68 of file XRYDataSourceProcessor.java.

---

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

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