Autopsy  4.19.0
Graphical digital forensics platform for The Sleuth Kit and other tools.
Public Member Functions | Static Public Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | Static Private Attributes | List of all members
org.sleuthkit.autopsy.datasourceprocessors.RawDSProcessor Class Reference

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

Public Member Functions

 RawDSProcessor ()
 
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 ()
 

Static Public Member Functions

static String getType ()
 

Private Member Functions

void run (String deviceId, String imageFilePath, String timeZone, long chunkSize, Host host, DataSourceProcessorProgressMonitor progressMonitor, DataSourceProcessorCallback callback)
 

Static Private Member Functions

static boolean isAcceptedByFiler (File file, List< FileFilter > filters)
 

Private Attributes

final RawDSInputPanel configPanel
 

Static Private Attributes

static final long DEFAULT_CHUNK_SIZE = 2000000000L
 
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)
 

Detailed Description

A Raw 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 49 of file RawDSProcessor.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.datasourceprocessors.RawDSProcessor.RawDSProcessor ( )

Definition at line 69 of file RawDSProcessor.java.

Member Function Documentation

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

int org.sleuthkit.autopsy.datasourceprocessors.RawDSProcessor.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
dataSourcePathPath 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 215 of file RawDSProcessor.java.

String org.sleuthkit.autopsy.datasourceprocessors.RawDSProcessor.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 93 of file RawDSProcessor.java.

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

static String org.sleuthkit.autopsy.datasourceprocessors.RawDSProcessor.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 81 of file RawDSProcessor.java.

static boolean org.sleuthkit.autopsy.datasourceprocessors.RawDSProcessor.isAcceptedByFiler ( File  file,
List< FileFilter >  filters 
)
staticprivate

Definition at line 205 of file RawDSProcessor.java.

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

void org.sleuthkit.autopsy.datasourceprocessors.RawDSProcessor.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
deviceIdAn ASCII-printable identifier for the device associated with the data source that is intended to be unique across multiple cases (e.g., a UUID).
dataSourcePathPath to the data source.
progressMonitorProgress monitor that will be used by the background task to report progress.
callBackCallback that will be used by the background task to return results.

Implements org.sleuthkit.autopsy.datasourceprocessors.AutoIngestDataSourceProcessor.

Definition at line 231 of file RawDSProcessor.java.

void org.sleuthkit.autopsy.datasourceprocessors.RawDSProcessor.process ( String  deviceId,
Path  dataSourcePath,
Host  host,
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
deviceIdAn ASCII-printable identifier for the device associated with the data source that is intended to be unique across multiple cases (e.g., a UUID).
dataSourcePathPath to the data source.
hostHost for this data source.
progressMonitorProgress monitor that will be used by the background task to report progress.
callBackCallback that will be used by the background task to return results.

Implements org.sleuthkit.autopsy.datasourceprocessors.AutoIngestDataSourceProcessor.

Definition at line 236 of file RawDSProcessor.java.

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
deviceIdAn ASCII-printable identifier for the device associated with the data source that is intended to be unique across multiple cases (e.g., a UUID).
dataSourcePathPath to the data source.
settingsThe ingest job settings.
progressMonitorProgress monitor that will be used by the background task to report progress.
callBackCallback 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
deviceIdAn ASCII-printable identifier for the device associated with the data source that is intended to be unique across multiple cases (e.g., a UUID).
dataSourcePathPath to the data source.
hostThe host for this data source.
settingsThe ingest job settings.
progressMonitorProgress monitor that will be used by the background task to report progress.
callBackCallback 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.RawDSProcessor.reset ( )

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

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor.

Definition at line 201 of file RawDSProcessor.java.

void org.sleuthkit.autopsy.datasourceprocessors.RawDSProcessor.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
progressMonitorProgress monitor that will be used by the background task to report progress.
callbackCallback that will be used by the background task to return results.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor.

Definition at line 139 of file RawDSProcessor.java.

void org.sleuthkit.autopsy.datasourceprocessors.RawDSProcessor.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
hostHost for the data source.
progressMonitorProgress monitor that will be used by the background task to report progress.
callbackCallback that will be used by the background task to return results.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor.

Definition at line 159 of file RawDSProcessor.java.

void org.sleuthkit.autopsy.datasourceprocessors.RawDSProcessor.run ( String  deviceId,
String  imageFilePath,
String  timeZone,
long  chunkSize,
Host  host,
DataSourceProcessorProgressMonitor  progressMonitor,
DataSourceProcessorCallback  callback 
)
private

Adds a "raw" 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
deviceIdAn ASCII-printable identifier for the device associated with the data source that is intended to be unique across multiple cases (e.g., a UUID).
imageFilePathPath to the image file.
timeZoneThe time zone to use when processing dates and times for the image, obtained from java.util.TimeZone.getID.
chunkSizeThe maximum size of each chunk of the raw data source as it is divided up into virtual unallocated space files.
hostThe host for this data source.
progressMonitorProgress monitor for reporting progress during processing.
callbackCallback to call when processing is done.

Definition at line 187 of file RawDSProcessor.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
settingsThe ingest job settings.
progressProgress monitor that will be used by the background task to report progress.
callBackCallback 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
hostHost for this data source.
settingsThe ingest job settings.
progressProgress monitor that will be used by the background task to report progress.
callBackCallback 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 RawDSInputPanel org.sleuthkit.autopsy.datasourceprocessors.RawDSProcessor.configPanel
private

Definition at line 51 of file RawDSProcessor.java.

final long org.sleuthkit.autopsy.datasourceprocessors.RawDSProcessor.DEFAULT_CHUNK_SIZE = 2000000000L
staticprivate

Definition at line 61 of file RawDSProcessor.java.

final GeneralFilter org.sleuthkit.autopsy.datasourceprocessors.RawDSProcessor.encaseFilter = new GeneralFilter(GeneralFilter.ENCASE_IMAGE_EXTS, GeneralFilter.ENCASE_IMAGE_DESC)
staticprivate

Definition at line 53 of file RawDSProcessor.java.

final List<FileFilter> org.sleuthkit.autopsy.datasourceprocessors.RawDSProcessor.filtersList = new ArrayList<>()
staticprivate

Definition at line 54 of file RawDSProcessor.java.

final GeneralFilter org.sleuthkit.autopsy.datasourceprocessors.RawDSProcessor.rawFilter = new GeneralFilter(GeneralFilter.RAW_IMAGE_EXTS, GeneralFilter.RAW_IMAGE_DESC)
staticprivate

Definition at line 52 of file RawDSProcessor.java.


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

Copyright © 2012-2021 Basis Technology. Generated on: Fri Aug 6 2021
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.