Sleuth Kit Java Bindings (JNI)  4.3
Java bindings for using The Sleuth Kit
org.sleuthkit.datamodel.VolumeSystem Class Reference

Inherits org.sleuthkit.datamodel.AbstractContent.

Public Member Functions

void close ()
 
void finalize () throws Throwable
 
long getBlockSize ()
 
List< ContentgetChildren () throws TskCoreException
 
List< Long > getChildrenIds () throws TskCoreException
 
long getOffset ()
 
long getSize ()
 
TSK_VS_TYPE_ENUM getType ()
 
List< VolumegetVolumes () throws TskCoreException
 
int read (byte[] readBuffer, long offset, long len) throws TskCoreException
 
String toString (boolean preserveState)
 
- Public Member Functions inherited from org.sleuthkit.datamodel.AbstractContent
boolean equals (Object obj)
 
ArrayList< BlackboardArtifactgetAllArtifacts () throws TskCoreException
 
long getAllArtifactsCount () throws TskCoreException
 
ArrayList< BlackboardArtifactgetArtifacts (String artifactTypeName) throws TskCoreException
 
ArrayList< BlackboardArtifactgetArtifacts (int artifactTypeID) throws TskCoreException
 
ArrayList< BlackboardArtifactgetArtifacts (BlackboardArtifact.ARTIFACT_TYPE type) throws TskCoreException
 
long getArtifactsCount (String artifactTypeName) throws TskCoreException
 
long getArtifactsCount (int artifactTypeID) throws TskCoreException
 
long getArtifactsCount (ARTIFACT_TYPE type) throws TskCoreException
 
int getChildrenCount () throws TskCoreException
 
Content getDataSource () throws TskCoreException
 
BlackboardArtifact getGenInfoArtifact () throws TskCoreException
 
BlackboardArtifact getGenInfoArtifact (boolean create) throws TskCoreException
 
ArrayList< BlackboardAttributegetGenInfoAttributes (ATTRIBUTE_TYPE attr_type) throws TskCoreException
 
Set< String > getHashSetNames () throws TskCoreException
 
long getId ()
 
String getName ()
 
synchronized Content getParent () throws TskCoreException
 
SleuthkitCase getSleuthkitCase ()
 
synchronized String getUniquePath () throws TskCoreException
 
boolean hasChildren () throws TskCoreException
 
int hashCode ()
 
BlackboardArtifact newArtifact (int artifactTypeID) throws TskCoreException
 
BlackboardArtifact newArtifact (BlackboardArtifact.ARTIFACT_TYPE type) throws TskCoreException
 
String toString ()
 
String toString (boolean preserveState)
 
- Public Member Functions inherited from org.sleuthkit.datamodel.Content
long getArtifactsCount (BlackboardArtifact.ARTIFACT_TYPE type) throws TskCoreException
 
ArrayList< BlackboardAttributegetGenInfoAttributes (BlackboardAttribute.ATTRIBUTE_TYPE attr_type) throws TskCoreException
 

Protected Member Functions

 VolumeSystem (SleuthkitCase db, long obj_id, String name, long type, long imgOffset, long blockSize)
 
synchronized long getVolumeSystemHandle () throws TskCoreException
 
- Protected Member Functions inherited from org.sleuthkit.datamodel.AbstractContent
 AbstractContent (SleuthkitCase db, long obj_id, String name)
 

Private Attributes

long type
 
volatile long volumeSystemHandle = 0
 

Additional Inherited Members

- Static Public Attributes inherited from org.sleuthkit.datamodel.AbstractContent
static final long UNKNOWN_ID = -1
 
- Protected Attributes inherited from org.sleuthkit.datamodel.AbstractContent
long parentId
 

Detailed Description

Represents a volume system. Populated based on data in database.

Definition at line 28 of file VolumeSystem.java.

Constructor & Destructor Documentation

org.sleuthkit.datamodel.VolumeSystem.VolumeSystem ( SleuthkitCase  db,
long  obj_id,
String  name,
long  type,
long  imgOffset,
long  blockSize 
)
protected

Constructor most inputs are from the database

Parameters
dbcase database handle
obj_idthe unique content object id for the volume system
namename of the volume system
typetype of the volume system
imgOffsetoffset of the volume system with respect to image
blockSizeblock size of this volume system

Definition at line 43 of file VolumeSystem.java.

References org.sleuthkit.datamodel.VolumeSystem.type.

Member Function Documentation

void org.sleuthkit.datamodel.VolumeSystem.close ( )

Free native resources after read is done on the Content object. After closing, read can be called again on the same Content object, which should result in re-opening of new native resources.

Implements org.sleuthkit.datamodel.Content.

Definition at line 115 of file VolumeSystem.java.

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

Referenced by org.sleuthkit.datamodel.VolumeSystem.finalize().

void org.sleuthkit.datamodel.VolumeSystem.finalize ( ) throws Throwable

Definition at line 127 of file VolumeSystem.java.

References org.sleuthkit.datamodel.VolumeSystem.close().

long org.sleuthkit.datamodel.VolumeSystem.getBlockSize ( )

get the block size

Returns
block size

Definition at line 88 of file VolumeSystem.java.

List<Content> org.sleuthkit.datamodel.VolumeSystem.getChildren ( ) throws TskCoreException

Gets the child content objects of this content.

Returns
List of children
Exceptions
TskCoreExceptionif critical error occurred within tsk core

Implements org.sleuthkit.datamodel.Content.

Definition at line 146 of file VolumeSystem.java.

References org.sleuthkit.datamodel.AbstractContent.getSleuthkitCase().

Referenced by org.sleuthkit.datamodel.VolumeSystem.getVolumes().

List<Long> org.sleuthkit.datamodel.VolumeSystem.getChildrenIds ( ) throws TskCoreException

Gets the child content ids of this content.

Returns
List of children ids
Exceptions
TskCoreExceptionif critical error occurred within tsk core

Implements org.sleuthkit.datamodel.Content.

Definition at line 151 of file VolumeSystem.java.

References org.sleuthkit.datamodel.AbstractContent.getSleuthkitCase().

long org.sleuthkit.datamodel.VolumeSystem.getOffset ( )

get the byte offset

Returns
byte offset

Definition at line 79 of file VolumeSystem.java.

long org.sleuthkit.datamodel.VolumeSystem.getSize ( )

Get the (reported) size of the content object and, in theory, how much you should be able to read from it. In some cases, data corruption may mean that you cannot read this much data.

Returns
size of the content in bytes

Implements org.sleuthkit.datamodel.Content.

Definition at line 61 of file VolumeSystem.java.

TSK_VS_TYPE_ENUM org.sleuthkit.datamodel.VolumeSystem.getType ( )

get the type

Returns
type

Definition at line 70 of file VolumeSystem.java.

References org.sleuthkit.datamodel.TskData.TSK_VS_TYPE_ENUM.valueOf().

List<Volume> org.sleuthkit.datamodel.VolumeSystem.getVolumes ( ) throws TskCoreException
Returns
a list of Volumes that are direct children of this VolumeSystem
Exceptions
TskCoreException

Definition at line 160 of file VolumeSystem.java.

References org.sleuthkit.datamodel.VolumeSystem.getChildren().

synchronized long org.sleuthkit.datamodel.VolumeSystem.getVolumeSystemHandle ( ) throws TskCoreException
protected

get the volume system Handle pointer Open a new handle if needed, otherwise resuse the existing handle.

Returns
volume system Handle pointer
Exceptions
TskException

Definition at line 100 of file VolumeSystem.java.

References org.sleuthkit.datamodel.AbstractContent.getDataSource(), org.sleuthkit.datamodel.Image.getImageHandle(), org.sleuthkit.datamodel.SleuthkitJNI.openVs(), and org.sleuthkit.datamodel.VolumeSystem.volumeSystemHandle.

Referenced by org.sleuthkit.datamodel.VolumeSystem.read(), and org.sleuthkit.datamodel.Volume.read().

int org.sleuthkit.datamodel.VolumeSystem.read ( byte[]  buf,
long  offset,
long  len 
) throws TskCoreException

Reads data that this content object is associated with (file contents, volume contents, etc.).

Parameters
bufa character array of data (in bytes) to copy read data to
offsetbyte offset in the content to start reading from
lennumber of bytes to read into buf.
Returns
num of bytes read, or -1 on error
Exceptions
TskCoreExceptionif critical error occurred during read in the tsk core

Implements org.sleuthkit.datamodel.Content.

Definition at line 51 of file VolumeSystem.java.

References org.sleuthkit.datamodel.VolumeSystem.getVolumeSystemHandle(), and org.sleuthkit.datamodel.SleuthkitJNI.readVs().

String org.sleuthkit.datamodel.VolumeSystem.toString ( boolean  preserveState)

Definition at line 171 of file VolumeSystem.java.

Member Data Documentation

long org.sleuthkit.datamodel.VolumeSystem.type
private

Definition at line 31 of file VolumeSystem.java.

Referenced by org.sleuthkit.datamodel.VolumeSystem.VolumeSystem().

volatile long org.sleuthkit.datamodel.VolumeSystem.volumeSystemHandle = 0
private

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.