org.sleuthkit.datamodel.VolumeSystem Class Reference

Inherits org.sleuthkit.datamodel.AbstractContent.

Public Member Functions
void	close ()
void	finalize () throws Throwable
long	getBlockSize ()
List< Content >	getChildren () throws TskCoreException
List< Long >	getChildrenIds () throws TskCoreException
long	getOffset ()
long	getSize ()
TSK_VS_TYPE_ENUM	getType ()
List< Volume >	getVolumes () 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)
Score	getAggregateScore () throws TskCoreException
List< AnalysisResult >	getAllAnalysisResults () throws TskCoreException
ArrayList< BlackboardArtifact >	getAllArtifacts () throws TskCoreException
long	getAllArtifactsCount () throws TskCoreException
List< DataArtifact >	getAllDataArtifacts () throws TskCoreException
List< AnalysisResult >	getAnalysisResults (BlackboardArtifact.Type artifactType) throws TskCoreException
ArrayList< BlackboardArtifact >	getArtifacts (BlackboardArtifact.ARTIFACT_TYPE type) throws TskCoreException
ArrayList< BlackboardArtifact >	getArtifacts (int artifactTypeID) throws TskCoreException
ArrayList< BlackboardArtifact >	getArtifacts (String artifactTypeName) throws TskCoreException
long	getArtifactsCount (ARTIFACT_TYPE type) throws TskCoreException
long	getArtifactsCount (int artifactTypeID) throws TskCoreException
long	getArtifactsCount (String artifactTypeName) throws TskCoreException
int	getChildrenCount () throws TskCoreException
Content	getDataSource () throws TskCoreException
BlackboardArtifact	getGenInfoArtifact () throws TskCoreException
BlackboardArtifact	getGenInfoArtifact (boolean create) throws TskCoreException
ArrayList< BlackboardAttribute >	getGenInfoAttributes (ATTRIBUTE_TYPE attr_type) throws TskCoreException
Set< String >	getHashSetNames () throws TskCoreException
long	getId ()
String	getName ()
Content	getParent () throws TskCoreException
Optional< Long >	getParentId () throws TskCoreException
SleuthkitCase	getSleuthkitCase ()
String	getUniquePath () throws TskCoreException
boolean	hasChildren () throws TskCoreException
int	hashCode ()
AnalysisResultAdded	newAnalysisResult (BlackboardArtifact.Type artifactType, Score score, String conclusion, String configuration, String justification, Collection< BlackboardAttribute > attributesList) throws TskCoreException
AnalysisResultAdded	newAnalysisResult (BlackboardArtifact.Type artifactType, Score score, String conclusion, String configuration, String justification, Collection< BlackboardAttribute > attributesList, long dataSourceId) throws TskCoreException
BlackboardArtifact	newArtifact (BlackboardArtifact.ARTIFACT_TYPE type) throws TskCoreException
BlackboardArtifact	newArtifact (int artifactTypeID) throws TskCoreException
DataArtifact	newDataArtifact (BlackboardArtifact.Type artifactType, Collection< BlackboardAttribute > attributesList) throws TskCoreException
DataArtifact	newDataArtifact (BlackboardArtifact.Type artifactType, Collection< BlackboardAttribute > attributesList, Long osAccountId) throws TskCoreException
DataArtifact	newDataArtifact (BlackboardArtifact.Type artifactType, Collection< BlackboardAttribute > attributesList, Long osAccountId, long dataSourceId) throws TskCoreException
String	toString ()
Public Member Functions inherited from org.sleuthkit.datamodel.Content
long	getArtifactsCount (BlackboardArtifact.ARTIFACT_TYPE type) throws TskCoreException
ArrayList< BlackboardAttribute >	getGenInfoAttributes (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)

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

VolumeSystem()

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

db	case database handle
obj_id	the unique content object id for the volume system
name	name of the volume system
type	type of the volume system
imgOffset	offset of the volume system with respect to image
blockSize	block size of this volume system

Definition at line 43 of file VolumeSystem.java.

Member Function Documentation

close()

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.

Referenced by finalize().

finalize()

void org.sleuthkit.datamodel.VolumeSystem.finalize

(

)

throws Throwable

Definition at line 128 of file VolumeSystem.java.

References close().

getBlockSize()

long org.sleuthkit.datamodel.VolumeSystem.getBlockSize

(

)

get the block size

Returns

block size

Definition at line 88 of file VolumeSystem.java.

getChildren()

List< Content > org.sleuthkit.datamodel.VolumeSystem.getChildren

(

)

throws TskCoreException

Gets all children of this abstract content, if any.

Returns

A list of the children.

Exceptions

TskCoreException

if there was an error querying the case database.

Reimplemented from org.sleuthkit.datamodel.AbstractContent.

Definition at line 147 of file VolumeSystem.java.

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

Referenced by getVolumes().

getChildrenIds()

List< Long > org.sleuthkit.datamodel.VolumeSystem.getChildrenIds

(

)

throws TskCoreException

Gets the object ids of objects, if any, that are children of this abstract content.

Returns

A list of the object ids.

Exceptions

TskCoreException

if there was an error querying the case database.

Reimplemented from org.sleuthkit.datamodel.AbstractContent.

Definition at line 152 of file VolumeSystem.java.

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

getOffset()

long org.sleuthkit.datamodel.VolumeSystem.getOffset

(

)

get the byte offset

Returns

byte offset

Definition at line 79 of file VolumeSystem.java.

getSize()

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.

getType()

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

Referenced by org.sleuthkit.datamodel.Volume.read().

getVolumes()

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 161 of file VolumeSystem.java.

References getChildren().

getVolumeSystemHandle()

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(), and org.sleuthkit.datamodel.SleuthkitJNI.openVs().

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

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

buf	a character array of data (in bytes) to copy read data to
offset	byte offset in the content to start reading from
len	number of bytes to read into buf.

Returns

num of bytes read, or -1 on error

Exceptions

TskCoreException

if critical error occurred during read in the tsk core

Implements org.sleuthkit.datamodel.Content.

Definition at line 51 of file VolumeSystem.java.

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

toString()

String org.sleuthkit.datamodel.VolumeSystem.toString

(

boolean

preserveState

)

Reimplemented from org.sleuthkit.datamodel.AbstractContent.

Definition at line 172 of file VolumeSystem.java.

---

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

• /home/carriersleuth/repos/sleuthkit/bindings/java/src/org/sleuthkit/datamodel/VolumeSystem.java