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

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

Public Member Functions

 LocalFilesDSProcessor ()
 
void cancel ()
 
int canProcess (Path dataSourcePath) throws AutoIngestDataSourceProcessorException
 
String getDataSourceType ()
 
JPanel getPanel ()
 
boolean isPanelValid ()
 
void process (String deviceId, Path dataSourcePath, DataSourceProcessorProgressMonitor progressMonitor, DataSourceProcessorCallback callBack) throws AutoIngestDataSourceProcessorException
 
void reset ()
 
void run (DataSourceProcessorProgressMonitor progressMonitor, DataSourceProcessorCallback callback)
 
void run (String deviceId, String rootVirtualDirectoryName, List< String > localFilePaths, DataSourceProcessorProgressMonitor progressMonitor, DataSourceProcessorCallback callback)
 
void setDataSourceOptions (String paths)
 

Static Public Member Functions

static String getType ()
 

Private Attributes

final LocalFilesPanel configPanel
 
List< String > localFilePaths
 
boolean setDataSourceOptionsCalled
 

Static Private Attributes

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

Detailed Description

A local/logical files and/or directories 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 44 of file LocalFilesDSProcessor.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.casemodule.LocalFilesDSProcessor.LocalFilesDSProcessor ( )

Constructs a local/logical files and/or directories 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 61 of file LocalFilesDSProcessor.java.

Member Function Documentation

void org.sleuthkit.autopsy.casemodule.LocalFilesDSProcessor.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.

TODO (AUT-1907): Implement cancellation by deleting rows added to the case database.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor.

Definition at line 174 of file LocalFilesDSProcessor.java.

int org.sleuthkit.autopsy.casemodule.LocalFilesDSProcessor.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.corecomponentinterfaces.AutomatedIngestDataSourceProcessor.AutomatedIngestDataSourceProcessorException

Implements org.sleuthkit.autopsy.framework.AutoIngestDataSourceProcessor.

Definition at line 189 of file LocalFilesDSProcessor.java.

String org.sleuthkit.autopsy.casemodule.LocalFilesDSProcessor.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 LocalFilesDSProcessor.java.

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

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

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

void org.sleuthkit.autopsy.casemodule.LocalFilesDSProcessor.process ( String  deviceId,
Path  dataSourcePath,
DataSourceProcessorProgressMonitor  progressMonitor,
DataSourceProcessorCallback  callBack 
) throws AutoIngestDataSourceProcessorException

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.
Exceptions
org.sleuthkit.autopsy.corecomponentinterfaces.AutomatedIngestDataSourceProcessor.AutomatedIngestDataSourceProcessorException

Implements org.sleuthkit.autopsy.framework.AutoIngestDataSourceProcessor.

Definition at line 197 of file LocalFilesDSProcessor.java.

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

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

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor.

Definition at line 182 of file LocalFilesDSProcessor.java.

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

void org.sleuthkit.autopsy.casemodule.LocalFilesDSProcessor.run ( String  deviceId,
String  rootVirtualDirectoryName,
List< String >  localFilePaths,
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
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).
rootVirtualDirectoryNameThe name to give to the virtual directory that will serve as the root for the local/logical files and/or directories that compose the data source. Pass the empty string to get a default name of the form: LogicalFileSet[N]
localFilePathsA list of local/logical file and/or directory localFilePaths.
progressMonitorProgress monitor for reporting progress during processing.
callbackCallback to call when processing is done.

Definition at line 159 of file LocalFilesDSProcessor.java.

void org.sleuthkit.autopsy.casemodule.LocalFilesDSProcessor.setDataSourceOptions ( String  paths)

Sets the configuration of the data source processor without using the configuration panel. The data source processor will assign a UUID to the data source and will use the time zone of the machine executing this code when when processing dates and times for the image.

Parameters
pathsA list of local/logical file and/or directory localFilePaths.
Deprecated:
Use the provided overload of the run method instead.

Definition at line 214 of file LocalFilesDSProcessor.java.

Member Data Documentation

final LocalFilesPanel org.sleuthkit.autopsy.casemodule.LocalFilesDSProcessor.configPanel
private

Definition at line 47 of file LocalFilesDSProcessor.java.

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

Definition at line 46 of file LocalFilesDSProcessor.java.

List<String> org.sleuthkit.autopsy.casemodule.LocalFilesDSProcessor.localFilePaths
private

Definition at line 52 of file LocalFilesDSProcessor.java.

boolean org.sleuthkit.autopsy.casemodule.LocalFilesDSProcessor.setDataSourceOptionsCalled
private

Definition at line 53 of file LocalFilesDSProcessor.java.


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

Copyright © 2012-2016 Basis Technology. Generated on: Mon Apr 24 2017
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.