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

Public Member Functions
	ImageDSProcessor ()

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)

void	run (String deviceId, String imagePath, String timeZone, boolean ignoreFatOrphanFiles, DataSourceProcessorProgressMonitor progressMonitor, DataSourceProcessorCallback callback)

void	setDataSourceOptions (String imagePath, String timeZone, boolean ignoreFatOrphanFiles)

Static Public Member Functions
static String	getType ()

Private Member Functions
void	run (String deviceId, String imagePath, int sectorSize, String timeZone, boolean ignoreFatOrphanFiles, DataSourceProcessorProgressMonitor progressMonitor, DataSourceProcessorCallback callback)

Static Private Member Functions
static boolean	isAcceptedByFiler (File file, List< FileFilter > filters)

Private Attributes
AddImageTask	addImageTask

final ImageFilePanel	configPanel

String	deviceId

boolean	ignoreFatOrphanFiles

String	imagePath

int	sectorSize

boolean	setDataSourceOptionsCalled

String	timeZone

Static Private Attributes
static final String	ALL_DESC = NbBundle.getMessage(ImageDSProcessor.class, "ImageDSProcessor.allDesc.text")

static final List< String >	allExt = new ArrayList<>()

static final GeneralFilter	allFilter = new GeneralFilter(allExt, ALL_DESC)

static final String	DATA_SOURCE_TYPE = NbBundle.getMessage(ImageDSProcessor.class, "ImageDSProcessor.dsType.text")

static final GeneralFilter	encaseFilter = new GeneralFilter(GeneralFilter.ENCASE_IMAGE_EXTS, GeneralFilter.ENCASE_IMAGE_DESC)

static final List< FileFilter >	filtersList = new ArrayList<>()

static final GeneralFilter	rawFilter = new GeneralFilter(GeneralFilter.RAW_IMAGE_EXTS, GeneralFilter.RAW_IMAGE_DESC)

static final GeneralFilter	virtualMachineFilter = new GeneralFilter(GeneralFilter.VIRTUAL_MACHINE_EXTS, GeneralFilter.VIRTUAL_MACHINE_DESC)

Detailed Description

A image file 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 48 of file ImageDSProcessor.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.casemodule.ImageDSProcessor.ImageDSProcessor ( )

Constructs an image file 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 89 of file ImageDSProcessor.java.

References org.sleuthkit.autopsy.casemodule.ImageFilePanel.createInstance().

Member Function Documentation

void org.sleuthkit.autopsy.casemodule.ImageDSProcessor.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 230 of file ImageDSProcessor.java.

int org.sleuthkit.autopsy.casemodule.ImageDSProcessor.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

Implements org.sleuthkit.autopsy.datasourceprocessors.AutoIngestDataSourceProcessor.

Definition at line 260 of file ImageDSProcessor.java.

References org.sleuthkit.autopsy.casemodule.Case.getCurrentCaseThrows(), and org.sleuthkit.autopsy.coreutils.DataSourceUtils.imageHasFileSystem().

String org.sleuthkit.autopsy.casemodule.ImageDSProcessor.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 112 of file ImageDSProcessor.java.

JPanel org.sleuthkit.autopsy.casemodule.ImageDSProcessor.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 125 of file ImageDSProcessor.java.

References org.sleuthkit.autopsy.casemodule.ImageFilePanel.readSettings(), and org.sleuthkit.autopsy.casemodule.ImageFilePanel.select().

static String org.sleuthkit.autopsy.casemodule.ImageDSProcessor.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 100 of file ImageDSProcessor.java.

static boolean org.sleuthkit.autopsy.casemodule.ImageDSProcessor.isAcceptedByFiler	(	File	file,
		List< FileFilter >	filters
	)

staticprivate

Definition at line 250 of file ImageDSProcessor.java.

boolean org.sleuthkit.autopsy.casemodule.ImageDSProcessor.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 139 of file ImageDSProcessor.java.

References org.sleuthkit.autopsy.casemodule.ImageFilePanel.validatePanel().

void org.sleuthkit.autopsy.casemodule.ImageDSProcessor.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 283 of file ImageDSProcessor.java.

void org.sleuthkit.autopsy.casemodule.ImageDSProcessor.reset ( )

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

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor.

Definition at line 241 of file ImageDSProcessor.java.

References org.sleuthkit.autopsy.casemodule.ImageFilePanel.reset().

void org.sleuthkit.autopsy.casemodule.ImageDSProcessor.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 158 of file ImageDSProcessor.java.

References org.sleuthkit.autopsy.casemodule.ImageFilePanel.getContentPaths(), org.sleuthkit.autopsy.casemodule.ImageFilePanel.getNoFatOrphans(), org.sleuthkit.autopsy.casemodule.ImageFilePanel.getSectorSize(), org.sleuthkit.autopsy.casemodule.ImageFilePanel.getTimeZone(), and org.sleuthkit.autopsy.casemodule.ImageFilePanel.storeSettings().

void org.sleuthkit.autopsy.casemodule.ImageDSProcessor.run	(	String	deviceId,
		String	imagePath,
		String	timeZone,
		boolean	ignoreFatOrphanFiles,
		DataSourceProcessorProgressMonitor	progressMonitor,
		DataSourceProcessorCallback	callback
	)

Adds a 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).
imagePath	Path to the image file.
timeZone	The time zone to use when processing dates and times for the image, obtained from java.util.TimeZone.getID.
ignoreFatOrphanFiles	Whether to parse orphans if the image has a FAT filesystem.
progressMonitor	Progress monitor for reporting progress during processing.
callback	Callback to call when processing is done.

Definition at line 191 of file ImageDSProcessor.java.

void org.sleuthkit.autopsy.casemodule.ImageDSProcessor.run	(	String	deviceId,
		String	imagePath,
		int	sectorSize,
		String	timeZone,
		boolean	ignoreFatOrphanFiles,
		DataSourceProcessorProgressMonitor	progressMonitor,
		DataSourceProcessorCallback	callback
	)

private

Adds a 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).
imagePath	Path to the image file.
sectorSize	The sector size (use '0' for autodetect).
timeZone	The time zone to use when processing dates and times for the image, obtained from java.util.TimeZone.getID.
ignoreFatOrphanFiles	Whether to parse orphans if the image has a FAT filesystem.
progressMonitor	Progress monitor for reporting progress during processing.
callback	Callback to call when processing is done.

Definition at line 217 of file ImageDSProcessor.java.

void org.sleuthkit.autopsy.casemodule.ImageDSProcessor.setDataSourceOptions	(	String	imagePath,
		String	timeZone,
		boolean	ignoreFatOrphanFiles
	)

Sets the configuration of the data source processor without using the selection and configuration panel.

Parameters

imagePath	Path to the image file.
timeZone	The time zone to use when processing dates and times for the image, obtained from java.util.TimeZone.getID.
ignoreFatOrphanFiles	Whether to parse orphans if the image has a FAT filesystem.

Deprecated:: Use the provided overload of the run method instead.

Definition at line 307 of file ImageDSProcessor.java.

Member Data Documentation

AddImageTask org.sleuthkit.autopsy.casemodule.ImageDSProcessor.addImageTask

private

Definition at line 59 of file ImageDSProcessor.java.

final String org.sleuthkit.autopsy.casemodule.ImageDSProcessor.ALL_DESC = NbBundle.getMessage(ImageDSProcessor.class, "ImageDSProcessor.allDesc.text")

staticprivate

Definition at line 55 of file ImageDSProcessor.java.

final List<String> org.sleuthkit.autopsy.casemodule.ImageDSProcessor.allExt = new ArrayList<>()

staticprivate

Definition at line 51 of file ImageDSProcessor.java.

final GeneralFilter org.sleuthkit.autopsy.casemodule.ImageDSProcessor.allFilter = new GeneralFilter(allExt, ALL_DESC)

staticprivate

Definition at line 56 of file ImageDSProcessor.java.

final ImageFilePanel org.sleuthkit.autopsy.casemodule.ImageDSProcessor.configPanel

private

Definition at line 58 of file ImageDSProcessor.java.

final String org.sleuthkit.autopsy.casemodule.ImageDSProcessor.DATA_SOURCE_TYPE = NbBundle.getMessage(ImageDSProcessor.class, "ImageDSProcessor.dsType.text")

staticprivate

Definition at line 50 of file ImageDSProcessor.java.

String org.sleuthkit.autopsy.casemodule.ImageDSProcessor.deviceId

private

Definition at line 64 of file ImageDSProcessor.java.

final GeneralFilter org.sleuthkit.autopsy.casemodule.ImageDSProcessor.encaseFilter = new GeneralFilter(GeneralFilter.ENCASE_IMAGE_EXTS, GeneralFilter.ENCASE_IMAGE_DESC)

staticprivate

Definition at line 53 of file ImageDSProcessor.java.

final List<FileFilter> org.sleuthkit.autopsy.casemodule.ImageDSProcessor.filtersList = new ArrayList<>()

staticprivate

Definition at line 57 of file ImageDSProcessor.java.

boolean org.sleuthkit.autopsy.casemodule.ImageDSProcessor.ignoreFatOrphanFiles

private

Definition at line 68 of file ImageDSProcessor.java.

String org.sleuthkit.autopsy.casemodule.ImageDSProcessor.imagePath

private

Definition at line 65 of file ImageDSProcessor.java.

final GeneralFilter org.sleuthkit.autopsy.casemodule.ImageDSProcessor.rawFilter = new GeneralFilter(GeneralFilter.RAW_IMAGE_EXTS, GeneralFilter.RAW_IMAGE_DESC)

staticprivate

Definition at line 52 of file ImageDSProcessor.java.

int org.sleuthkit.autopsy.casemodule.ImageDSProcessor.sectorSize

private

Definition at line 66 of file ImageDSProcessor.java.

boolean org.sleuthkit.autopsy.casemodule.ImageDSProcessor.setDataSourceOptionsCalled

private

Definition at line 69 of file ImageDSProcessor.java.

String org.sleuthkit.autopsy.casemodule.ImageDSProcessor.timeZone

private

Definition at line 67 of file ImageDSProcessor.java.

final GeneralFilter org.sleuthkit.autopsy.casemodule.ImageDSProcessor.virtualMachineFilter = new GeneralFilter(GeneralFilter.VIRTUAL_MACHINE_EXTS, GeneralFilter.VIRTUAL_MACHINE_DESC)

staticprivate

Definition at line 54 of file ImageDSProcessor.java.

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

/home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/casemodule/ImageDSProcessor.java

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation