Sleuth Kit Java Bindings (JNI)  4.4.1
Java bindings for using The Sleuth Kit
org.sleuthkit.datamodel.SleuthkitJNI.CaseDbHandle.AddImageProcess Class Reference

Public Member Functions

synchronized long commit () throws TskCoreException
 
synchronized String currentDirectory ()
 
synchronized void revert () throws TskCoreException
 
void run (String deviceId, String[] imageFilePaths) throws TskCoreException, TskDataException
 
void run (String[] imageFilePaths) throws TskCoreException, TskDataException
 
synchronized void stop () throws TskCoreException
 

Private Member Functions

 AddImageProcess (String timeZone, boolean addUnallocSpace, boolean skipFatFsOrphans, String imageWriterPath)
 

Private Attributes

final boolean addUnallocSpace
 
final String imageWriterPath
 
boolean isCanceled
 
final boolean skipFatFsOrphans
 
final String timeZone
 
volatile long tskAutoDbPointer
 

Detailed Description

Encapsulates a multi-step process to add an image to the case database.

Definition at line 251 of file SleuthkitJNI.java.

Constructor & Destructor Documentation

org.sleuthkit.datamodel.SleuthkitJNI.CaseDbHandle.AddImageProcess.AddImageProcess ( String  timeZone,
boolean  addUnallocSpace,
boolean  skipFatFsOrphans,
String  imageWriterPath 
)
private

Constructs an object that encapsulates a multi-step process to add an image to the case database.

Parameters
timeZoneThe time zone of the image.
addUnallocSpacePass true to create virtual files for unallocated space.
skipFatFsOrphansPass true to skip processing of orphan files for FAT file systems.
imageWriterPathPath that a copy of the image should be written to. Use empty string to disable image writing

Definition at line 273 of file SleuthkitJNI.java.

References org.sleuthkit.datamodel.SleuthkitJNI.CaseDbHandle.AddImageProcess.addUnallocSpace, org.sleuthkit.datamodel.SleuthkitJNI.CaseDbHandle.AddImageProcess.imageWriterPath, org.sleuthkit.datamodel.SleuthkitJNI.CaseDbHandle.AddImageProcess.skipFatFsOrphans, and org.sleuthkit.datamodel.SleuthkitJNI.CaseDbHandle.AddImageProcess.timeZone.

Member Function Documentation

synchronized long org.sleuthkit.datamodel.SleuthkitJNI.CaseDbHandle.AddImageProcess.commit ( ) throws TskCoreException

Completes the process of adding an image to the case database that was started by calling AddImageProcess.run.

Returns
The object id of the image that was added.
Exceptions
TskCoreExceptionif a critical error occurs within the SleuthKit.

Definition at line 360 of file SleuthkitJNI.java.

References org.sleuthkit.datamodel.SleuthkitJNI.commitAddImgNat().

Referenced by org.sleuthkit.datamodel.Examples.Sample.run().

synchronized String org.sleuthkit.datamodel.SleuthkitJNI.CaseDbHandle.AddImageProcess.currentDirectory ( )

Gets the file system directory currently being processed by the SleuthKit.

Returns
The directory

Definition at line 377 of file SleuthkitJNI.java.

References org.sleuthkit.datamodel.SleuthkitJNI.getCurDirNat().

synchronized void org.sleuthkit.datamodel.SleuthkitJNI.CaseDbHandle.AddImageProcess.revert ( ) throws TskCoreException

Rolls back the process of adding an image to the case database that was started by calling AddImageProcess.run.

Exceptions
TskCoreExceptionif a critical error occurs within the SleuthKit.

Definition at line 341 of file SleuthkitJNI.java.

References org.sleuthkit.datamodel.SleuthkitJNI.revertAddImgNat().

void org.sleuthkit.datamodel.SleuthkitJNI.CaseDbHandle.AddImageProcess.run ( String  deviceId,
String[]  imageFilePaths 
) throws TskCoreException, TskDataException

Starts the process of adding an image to the case database. Either AddImageProcess.commit or AddImageProcess.revert MUST be called after calling AddImageProcess.run.

Parameters
deviceIdAn ASCII-printable identifier for the device associated with the image that should be unique across multiple cases (e.g., a UUID).
imageFilePathsFull path(s) to the image file(s).
Exceptions
TskCoreExceptionif a critical error occurs within the SleuthKit.
TskDataExceptionif a non-critical error occurs within the SleuthKit (should be OK to continue the process)

Definition at line 299 of file SleuthkitJNI.java.

References org.sleuthkit.datamodel.SleuthkitJNI.initAddImgNat(), org.sleuthkit.datamodel.SleuthkitJNI.openImage(), org.sleuthkit.datamodel.SleuthkitJNI.runAddImgNat(), and org.sleuthkit.datamodel.SleuthkitJNI.timezoneLongToShort().

Referenced by org.sleuthkit.datamodel.Examples.Sample.run(), and org.sleuthkit.datamodel.SleuthkitJNI.CaseDbHandle.AddImageProcess.run().

void org.sleuthkit.datamodel.SleuthkitJNI.CaseDbHandle.AddImageProcess.run ( String[]  imageFilePaths) throws TskCoreException, TskDataException

Starts the process of adding an image to the case database. Either commit() or revert() MUST be called after calling run().

Parameters
imageFilePathsFull path(s) to the image file(s).
Exceptions
TskCoreExceptionif a critical error occurs within the SleuthKit.
TskDataExceptionif a non-critical error occurs within the SleuthKit (should be OK to continue the process)
Deprecated:
Use run(String dataSourceId, String[] imageFilePaths) instead

Definition at line 397 of file SleuthkitJNI.java.

References org.sleuthkit.datamodel.SleuthkitJNI.CaseDbHandle.AddImageProcess.run().

synchronized void org.sleuthkit.datamodel.SleuthkitJNI.CaseDbHandle.AddImageProcess.stop ( ) throws TskCoreException

Stops the process of adding the image to the case database that was started by calling AddImageProcess.run. AddImageProcess.revert should be called after calling AddImageProcess.stop.

Exceptions
TskCoreExceptionif a critical error occurs within the SleuthKit.

Definition at line 327 of file SleuthkitJNI.java.

References org.sleuthkit.datamodel.SleuthkitJNI.stopAddImgNat().

Member Data Documentation

final boolean org.sleuthkit.datamodel.SleuthkitJNI.CaseDbHandle.AddImageProcess.addUnallocSpace
private
final String org.sleuthkit.datamodel.SleuthkitJNI.CaseDbHandle.AddImageProcess.imageWriterPath
private
boolean org.sleuthkit.datamodel.SleuthkitJNI.CaseDbHandle.AddImageProcess.isCanceled
private

Definition at line 258 of file SleuthkitJNI.java.

final boolean org.sleuthkit.datamodel.SleuthkitJNI.CaseDbHandle.AddImageProcess.skipFatFsOrphans
private
final String org.sleuthkit.datamodel.SleuthkitJNI.CaseDbHandle.AddImageProcess.timeZone
private
volatile long org.sleuthkit.datamodel.SleuthkitJNI.CaseDbHandle.AddImageProcess.tskAutoDbPointer
private

Definition at line 257 of file SleuthkitJNI.java.


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

Copyright © 2011-2015 Brian Carrier. (carrier -at- sleuthkit -dot- org)
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.