org.sleuthkit.datamodel.AbstractContent Class Reference

Inherits org.sleuthkit.datamodel.Content.

Inherited by org.sleuthkit.datamodel.AbstractFile, org.sleuthkit.datamodel.FileSystem, org.sleuthkit.datamodel.Image, org.sleuthkit.datamodel.Volume, and org.sleuthkit.datamodel.VolumeSystem.

Public Member Functions
boolean	equals (Object obj)
ArrayList< BlackboardArtifact >	getAllArtifacts () throws TskCoreException
long	getAllArtifactsCount () throws TskCoreException
ArrayList< BlackboardArtifact >	getArtifacts (String artifactTypeName) throws TskCoreException
ArrayList< BlackboardArtifact >	getArtifacts (int artifactTypeID) throws TskCoreException
ArrayList< BlackboardArtifact >	getArtifacts (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< BlackboardAttribute >	getGenInfoAttributes (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
public< T > T	accept (ContentVisitor< T > v)
void	close ()
long	getArtifactsCount (BlackboardArtifact.ARTIFACT_TYPE type) throws TskCoreException
List< Content >	getChildren () throws TskCoreException
List< Long >	getChildrenIds () throws TskCoreException
ArrayList< BlackboardAttribute >	getGenInfoAttributes (BlackboardAttribute.ATTRIBUTE_TYPE attr_type) throws TskCoreException
long	getSize ()
int	read (byte[] buf, long offset, long len) throws TskCoreException
Public Member Functions inherited from org.sleuthkit.datamodel.SleuthkitVisitableItem
public< T > T	accept (SleuthkitItemVisitor< T > v)

Static Public Attributes
static final long	UNKNOWN_ID = -1

Protected Member Functions
	AbstractContent (SleuthkitCase db, long obj_id, String name)

Protected Attributes
long	parentId

Private Attributes
volatile boolean	checkedHasChildren
volatile int	childrenCount
final SleuthkitCase	db
BlackboardArtifact	genInfoArtifact = null
volatile boolean	hasChildren
String	name
long	objId
Content	parent
String	uniquePath

Detailed Description

Implements some general methods from the Content interface common across many content sub types

Definition at line 36 of file AbstractContent.java.

Constructor & Destructor Documentation

org.sleuthkit.datamodel.AbstractContent.AbstractContent ( SleuthkitCase  db, long  obj_id, String  name  )

protected

Definition at line 50 of file AbstractContent.java.

References org.sleuthkit.datamodel.AbstractContent.db, org.sleuthkit.datamodel.AbstractContent.name, and org.sleuthkit.datamodel.AbstractContent.UNKNOWN_ID.

Referenced by org.sleuthkit.datamodel.AbstractContent.equals().

Member Function Documentation

boolean org.sleuthkit.datamodel.AbstractContent.equals

(

Object

obj

)

Definition at line 172 of file AbstractContent.java.

References org.sleuthkit.datamodel.AbstractContent.AbstractContent(), and org.sleuthkit.datamodel.AbstractContent.objId.

ArrayList<BlackboardArtifact> org.sleuthkit.datamodel.AbstractContent.getAllArtifacts

(

)

throws TskCoreException

Get all artifacts associated with this content

Returns

a list of blackboard artifacts

Exceptions

TskCoreException

if critical error occurred within tsk core

Implements org.sleuthkit.datamodel.Content.

Definition at line 283 of file AbstractContent.java.

References org.sleuthkit.datamodel.SleuthkitCase.getMatchingArtifacts().

long org.sleuthkit.datamodel.AbstractContent.getAllArtifactsCount

(

)

throws TskCoreException

Get count of all artifacts associated with this content

Returns

count of all blackboard artifacts for this content

Exceptions

TskCoreException

if critical error occurred within tsk core

Implements org.sleuthkit.datamodel.Content.

Definition at line 303 of file AbstractContent.java.

References org.sleuthkit.datamodel.SleuthkitCase.getBlackboardArtifactsCount().

ArrayList<BlackboardArtifact> org.sleuthkit.datamodel.AbstractContent.getArtifacts

(

String

artifactTypeName

)

throws TskCoreException

Get all artifacts associated with this content that have the given type name

Parameters

artifactTypeName

name of the type to look up

Returns

a list of blackboard artifacts matching the type

Exceptions

TskCoreException

if critical error occurred within tsk core

Implements org.sleuthkit.datamodel.Content.

Definition at line 208 of file AbstractContent.java.

References org.sleuthkit.datamodel.BlackboardArtifact.ARTIFACT_TYPE.fromLabel(), and org.sleuthkit.datamodel.BlackboardArtifact.ARTIFACT_TYPE.getTypeID().

Referenced by org.sleuthkit.datamodel.AbstractContent.getArtifacts(), and org.sleuthkit.datamodel.AbstractContent.getHashSetNames().

ArrayList<BlackboardArtifact> org.sleuthkit.datamodel.AbstractContent.getArtifacts

(

int

artifactTypeID

)

throws TskCoreException

Get all artifacts associated with this content that have the given type id

Parameters

artifactTypeID

type id to look up

Returns

a list of blackboard artifacts matching the type

Exceptions

TskCoreException

if critical error occurred within tsk core

Implements org.sleuthkit.datamodel.Content.

Definition at line 213 of file AbstractContent.java.

References org.sleuthkit.datamodel.SleuthkitCase.getBlackboardArtifacts(), org.sleuthkit.datamodel.AbstractContent.getGenInfoArtifact(), and org.sleuthkit.datamodel.BlackboardArtifact.ARTIFACT_TYPE.TSK_GEN_INFO.

ArrayList<BlackboardArtifact> org.sleuthkit.datamodel.AbstractContent.getArtifacts

(

BlackboardArtifact.ARTIFACT_TYPE

type

)

throws TskCoreException

Get all artifacts associated with this content that have the given type

Parameters

type	type to look up

Returns

a list of blackboard artifacts matching the type

Exceptions

TskCoreException

if critical error occurred within tsk core

Implements org.sleuthkit.datamodel.Content.

Definition at line 231 of file AbstractContent.java.

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

long org.sleuthkit.datamodel.AbstractContent.getArtifactsCount

(

String

artifactTypeName

)

throws TskCoreException

Get count of all artifacts associated with this content that have the given type name

Parameters

artifactTypeName

name of the type to look up

Returns

count of blackboard artifacts matching the type

Exceptions

TskCoreException

if critical error occurred within tsk core

Implements org.sleuthkit.datamodel.Content.

Definition at line 288 of file AbstractContent.java.

References org.sleuthkit.datamodel.SleuthkitCase.getBlackboardArtifactsCount().

long org.sleuthkit.datamodel.AbstractContent.getArtifactsCount

(

int

artifactTypeID

)

throws TskCoreException

Get count of all artifacts associated with this content that have the given type id

Parameters

artifactTypeID

type id to look up

Returns

count of blackboard artifacts matching the type

Exceptions

TskCoreException

if critical error occurred within tsk core

Implements org.sleuthkit.datamodel.Content.

Definition at line 293 of file AbstractContent.java.

References org.sleuthkit.datamodel.SleuthkitCase.getBlackboardArtifactsCount().

long org.sleuthkit.datamodel.AbstractContent.getArtifactsCount

(

ARTIFACT_TYPE

type

)

throws TskCoreException

Definition at line 298 of file AbstractContent.java.

References org.sleuthkit.datamodel.SleuthkitCase.getBlackboardArtifactsCount().

int org.sleuthkit.datamodel.AbstractContent.getChildrenCount

(

)

throws TskCoreException

Returns count of children objects. Note, this should be more efficient than getting children and counting them.

Returns

children count

Exceptions

TskCoreException

if critical error occurred within tsk core

Implements org.sleuthkit.datamodel.Content.

Definition at line 104 of file AbstractContent.java.

References org.sleuthkit.datamodel.AbstractContent.childrenCount, and org.sleuthkit.datamodel.AbstractContent.getSleuthkitCase().

Content org.sleuthkit.datamodel.AbstractContent.getDataSource

(

)

throws TskCoreException

Get the root data source of this content (image, virtual directory, etc.)

Returns

Content associated with data source or null if one can't be found

Exceptions

TskCoreException

if critical error occurred within tsk core

Implements org.sleuthkit.datamodel.Content.

Definition at line 153 of file AbstractContent.java.

References org.sleuthkit.datamodel.Content.getDataSource(), and org.sleuthkit.datamodel.AbstractContent.getParent().

Referenced by org.sleuthkit.datamodel.FsContent.getDataSource(), org.sleuthkit.datamodel.VolumeSystem.getVolumeSystemHandle(), and org.sleuthkit.datamodel.LayoutFile.readInt().

BlackboardArtifact org.sleuthkit.datamodel.AbstractContent.getGenInfoArtifact

(

)

throws TskCoreException

Return the TSK_GEN_INFO artifact for the file so that individual attributes can be added to it. Creates one if it does not already exist.

Returns

Instance of the TSK_GEN_INFO artifact

Exceptions

TskCoreException

Implements org.sleuthkit.datamodel.Content.

Definition at line 236 of file AbstractContent.java.

Referenced by org.sleuthkit.datamodel.AbstractContent.getArtifacts(), org.sleuthkit.datamodel.AbstractContent.getGenInfoAttributes(), and org.sleuthkit.datamodel.AbstractContent.newArtifact().

BlackboardArtifact org.sleuthkit.datamodel.AbstractContent.getGenInfoArtifact

(

boolean

create

)

throws TskCoreException

Return the TSK_GEN_INFO artifact for the file so that individual attributes can be added to it. If one does not create, behavior depends on the create argument.

Parameters

create

If true, an artifact will be created if it does not already exist.

Returns

Instance of the TSK_GEN_INFO artifact or null if artifact does not already exist and create was set to false

Exceptions

TskCoreException

Implements org.sleuthkit.datamodel.Content.

Definition at line 241 of file AbstractContent.java.

References org.sleuthkit.datamodel.AbstractContent.genInfoArtifact, org.sleuthkit.datamodel.SleuthkitCase.getBlackboardArtifacts(), org.sleuthkit.datamodel.SleuthkitCase.newBlackboardArtifact(), and org.sleuthkit.datamodel.BlackboardArtifact.ARTIFACT_TYPE.TSK_GEN_INFO.

ArrayList<BlackboardAttribute> org.sleuthkit.datamodel.AbstractContent.getGenInfoAttributes

(

ATTRIBUTE_TYPE

attr_type

)

throws TskCoreException

Definition at line 263 of file AbstractContent.java.

References org.sleuthkit.datamodel.BlackboardArtifact.getAttributes(), and org.sleuthkit.datamodel.AbstractContent.getGenInfoArtifact().

Referenced by org.sleuthkit.datamodel.AbstractFile.isMimeType().

Set<String> org.sleuthkit.datamodel.AbstractContent.getHashSetNames

(

)

throws TskCoreException

Get the names of all the hashsets that this content is in.

Returns

the names of the hashsets that this content is in if critical error occurred within tsk core

Implements org.sleuthkit.datamodel.Content.

Definition at line 308 of file AbstractContent.java.

References org.sleuthkit.datamodel.AbstractContent.getArtifacts(), org.sleuthkit.datamodel.BlackboardArtifact.ARTIFACT_TYPE.TSK_HASHSET_HIT, and org.sleuthkit.datamodel.BlackboardAttribute.ATTRIBUTE_TYPE.TSK_SET_NAME.

long org.sleuthkit.datamodel.AbstractContent.getId

(

)

Returns the unique object ID that was assigned to it in the database. This is a Sleuth Kit database-assigned number.

Returns

object id

Implements org.sleuthkit.datamodel.Content.

Definition at line 147 of file AbstractContent.java.

References org.sleuthkit.datamodel.AbstractContent.objId.

Referenced by org.sleuthkit.datamodel.SleuthkitCase.addCarvedFiles(), org.sleuthkit.datamodel.DerivedFile.getDerivedMethod(), org.sleuthkit.datamodel.SleuthkitCase.getFileSystems(), and org.sleuthkit.datamodel.AbstractFile.getRanges().

String org.sleuthkit.datamodel.AbstractContent.getName

(

)

Get the name of this content object (does not include parent path)

Returns

the name

Implements org.sleuthkit.datamodel.Content.

Definition at line 62 of file AbstractContent.java.

References org.sleuthkit.datamodel.AbstractContent.name.

Referenced by org.sleuthkit.datamodel.LayoutFile.calcSize(), org.sleuthkit.datamodel.AbstractFile.close(), org.sleuthkit.datamodel.AbstractFile.getNameExtension(), org.sleuthkit.datamodel.LayoutFile.getNumParts(), org.sleuthkit.datamodel.Image.getSize(), org.sleuthkit.datamodel.AbstractContent.getUniquePath(), org.sleuthkit.datamodel.Volume.getUniquePath(), org.sleuthkit.datamodel.Image.getUniquePath(), org.sleuthkit.datamodel.FsContent.getUniquePath(), and org.sleuthkit.datamodel.AbstractContent.toString().

synchronized Content org.sleuthkit.datamodel.AbstractContent.getParent

(

)

throws TskCoreException

Returns

returns the parent of this Content object or null if there isn't one as is the case for Image.

Exceptions

TskCoreException

Implements org.sleuthkit.datamodel.Content.

Definition at line 118 of file AbstractContent.java.

References org.sleuthkit.datamodel.SleuthkitCase.getContentById(), and org.sleuthkit.datamodel.AbstractContent.parent.

Referenced by org.sleuthkit.datamodel.VirtualDirectory.getDataSource(), org.sleuthkit.datamodel.DerivedFile.getDataSource(), org.sleuthkit.datamodel.AbstractContent.getDataSource(), org.sleuthkit.datamodel.OSUtility.getOSInfoInternal(), org.sleuthkit.datamodel.AbstractContent.getUniquePath(), org.sleuthkit.datamodel.Volume.getUniquePath(), org.sleuthkit.datamodel.Volume.read(), and org.sleuthkit.datamodel.AbstractContent.toString().

SleuthkitCase org.sleuthkit.datamodel.AbstractContent.getSleuthkitCase

(

)

Gets handle of SleuthkitCase to which this content belongs

Returns

the case handle

Definition at line 167 of file AbstractContent.java.

References org.sleuthkit.datamodel.AbstractContent.db.

Referenced by org.sleuthkit.datamodel.VirtualDirectory.getChildren(), org.sleuthkit.datamodel.LayoutFile.getChildren(), org.sleuthkit.datamodel.File.getChildren(), org.sleuthkit.datamodel.Directory.getChildren(), org.sleuthkit.datamodel.DerivedFile.getChildren(), org.sleuthkit.datamodel.VolumeSystem.getChildren(), org.sleuthkit.datamodel.LocalFile.getChildren(), org.sleuthkit.datamodel.FileSystem.getChildren(), org.sleuthkit.datamodel.Image.getChildren(), org.sleuthkit.datamodel.Volume.getChildren(), org.sleuthkit.datamodel.AbstractContent.getChildrenCount(), org.sleuthkit.datamodel.VirtualDirectory.getChildrenIds(), org.sleuthkit.datamodel.LayoutFile.getChildrenIds(), org.sleuthkit.datamodel.Directory.getChildrenIds(), org.sleuthkit.datamodel.File.getChildrenIds(), org.sleuthkit.datamodel.DerivedFile.getChildrenIds(), org.sleuthkit.datamodel.VolumeSystem.getChildrenIds(), org.sleuthkit.datamodel.LocalFile.getChildrenIds(), org.sleuthkit.datamodel.FileSystem.getChildrenIds(), org.sleuthkit.datamodel.Image.getChildrenIds(), org.sleuthkit.datamodel.Volume.getChildrenIds(), org.sleuthkit.datamodel.DerivedFile.getDerivedMethod(), org.sleuthkit.datamodel.FsContent.getFileSystem(), org.sleuthkit.datamodel.Image.getFileSystems(), org.sleuthkit.datamodel.FsContent.getParentDirectory(), org.sleuthkit.datamodel.AbstractFile.getRanges(), org.sleuthkit.datamodel.AbstractContent.hasChildren(), and org.sleuthkit.datamodel.AbstractFile.setLocalPath().

synchronized String org.sleuthkit.datamodel.AbstractContent.getUniquePath

(

)

throws TskCoreException

Returns

returns the full path to this Content object starting with a "/" followed by the Image name and similarly for all other segments in the hierarchy.

Implements org.sleuthkit.datamodel.Content.

Definition at line 72 of file AbstractContent.java.

References org.sleuthkit.datamodel.AbstractContent.getName(), org.sleuthkit.datamodel.AbstractContent.getParent(), org.sleuthkit.datamodel.Content.getUniquePath(), and org.sleuthkit.datamodel.AbstractContent.uniquePath.

Referenced by org.sleuthkit.datamodel.AbstractContent.toString().

boolean org.sleuthkit.datamodel.AbstractContent.hasChildren

(

)

throws TskCoreException

Returns true if the content object has children objects. Note, this should be more efficient than getting children and checking it empty.

Returns

true if has children, false otherwise.

Exceptions

TskCoreException

if critical error occurred within tsk core

Implements org.sleuthkit.datamodel.Content.

Definition at line 88 of file AbstractContent.java.

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

int org.sleuthkit.datamodel.AbstractContent.hashCode

(

)

Definition at line 187 of file AbstractContent.java.

BlackboardArtifact org.sleuthkit.datamodel.AbstractContent.newArtifact

(

int

artifactTypeID

)

throws TskCoreException

Create and add an artifact associated with this content to the blackboard

Parameters

artifactTypeID

id of the artifact type (if the id doesn't already exist an exception will be thrown)

Returns

the blackboard artifact created (the artifact type id can be looked up from this)

Exceptions

TskCoreException

if critical error occurred within tsk core

Implements org.sleuthkit.datamodel.Content.

Definition at line 194 of file AbstractContent.java.

References org.sleuthkit.datamodel.AbstractContent.getGenInfoArtifact(), org.sleuthkit.datamodel.SleuthkitCase.newBlackboardArtifact(), and org.sleuthkit.datamodel.BlackboardArtifact.ARTIFACT_TYPE.TSK_GEN_INFO.

Referenced by org.sleuthkit.datamodel.AbstractContent.newArtifact().

BlackboardArtifact org.sleuthkit.datamodel.AbstractContent.newArtifact

(

BlackboardArtifact.ARTIFACT_TYPE

type

)

throws TskCoreException

Create and add an artifact associated with this content to the blackboard

Parameters

type	artifact enum tyoe

Returns

the blackboard artifact created (the artifact type id can be looked up from this)

Exceptions

TskCoreException

if critical error occurred within tsk core

Implements org.sleuthkit.datamodel.Content.

Definition at line 203 of file AbstractContent.java.

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

String org.sleuthkit.datamodel.AbstractContent.toString

(

)

Definition at line 322 of file AbstractContent.java.

String org.sleuthkit.datamodel.AbstractContent.toString

(

boolean

preserveState

)

Definition at line 326 of file AbstractContent.java.

References org.sleuthkit.datamodel.Content.getId(), org.sleuthkit.datamodel.AbstractContent.getName(), org.sleuthkit.datamodel.AbstractContent.getParent(), and org.sleuthkit.datamodel.AbstractContent.getUniquePath().

Member Data Documentation

volatile boolean org.sleuthkit.datamodel.AbstractContent.checkedHasChildren

private

Definition at line 46 of file AbstractContent.java.

volatile int org.sleuthkit.datamodel.AbstractContent.childrenCount

private

Definition at line 47 of file AbstractContent.java.

Referenced by org.sleuthkit.datamodel.AbstractContent.getChildrenCount().

final SleuthkitCase org.sleuthkit.datamodel.AbstractContent.db

private

Definition at line 39 of file AbstractContent.java.

Referenced by org.sleuthkit.datamodel.AbstractContent.AbstractContent(), org.sleuthkit.datamodel.AbstractContent.getSleuthkitCase(), org.sleuthkit.datamodel.Image.Image(), and org.sleuthkit.datamodel.LocalFile.LocalFile().

BlackboardArtifact org.sleuthkit.datamodel.AbstractContent.genInfoArtifact = null

private

Definition at line 48 of file AbstractContent.java.

Referenced by org.sleuthkit.datamodel.AbstractContent.getGenInfoArtifact().

volatile boolean org.sleuthkit.datamodel.AbstractContent.hasChildren

private

Definition at line 45 of file AbstractContent.java.

String org.sleuthkit.datamodel.AbstractContent.name

private

Definition at line 41 of file AbstractContent.java.

Referenced by org.sleuthkit.datamodel.AbstractContent.AbstractContent(), org.sleuthkit.datamodel.AbstractContent.getName(), org.sleuthkit.datamodel.Volume.getUniquePath(), org.sleuthkit.datamodel.Image.Image(), and org.sleuthkit.datamodel.LocalFile.LocalFile().

long org.sleuthkit.datamodel.AbstractContent.objId

private

Definition at line 40 of file AbstractContent.java.

Referenced by org.sleuthkit.datamodel.AbstractContent.equals(), org.sleuthkit.datamodel.AbstractContent.getId(), and org.sleuthkit.datamodel.LocalFile.LocalFile().

Content org.sleuthkit.datamodel.AbstractContent.parent

private

Definition at line 42 of file AbstractContent.java.

Referenced by org.sleuthkit.datamodel.VirtualDirectory.getDataSource(), org.sleuthkit.datamodel.DerivedFile.getDataSource(), and org.sleuthkit.datamodel.AbstractContent.getParent().

long org.sleuthkit.datamodel.AbstractContent.parentId

protected

Definition at line 44 of file AbstractContent.java.

String org.sleuthkit.datamodel.AbstractContent.uniquePath

private

Definition at line 43 of file AbstractContent.java.

Referenced by org.sleuthkit.datamodel.AbstractContent.getUniquePath(), and org.sleuthkit.datamodel.Volume.getUniquePath().

final long org.sleuthkit.datamodel.AbstractContent.UNKNOWN_ID = -1

static

Definition at line 38 of file AbstractContent.java.

Referenced by org.sleuthkit.datamodel.AbstractContent.AbstractContent(), org.sleuthkit.datamodel.FsContent.getFileSystem(), and org.sleuthkit.datamodel.SleuthkitCase.resultSetToAbstractFiles().

---

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

• bindings/java/src/org/sleuthkit/datamodel/AbstractContent.java