org.sleuthkit.datamodel.BlackboardAttribute Class Reference

Classes
enum	ATTRIBUTE_TYPE
enum	TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE

Public Member Functions
	BlackboardAttribute (int attributeTypeID, String moduleName, int valueInt)
	BlackboardAttribute (int attributeTypeID, String moduleName, String context, int valueInt)
	BlackboardAttribute (int attributeTypeID, String moduleName, long valueLong)
	BlackboardAttribute (int attributeTypeID, String moduleName, String context, long valueLong)
	BlackboardAttribute (int attributeTypeID, String moduleName, double valueDouble)
	BlackboardAttribute (int attributeTypeID, String moduleName, String context, double valueDouble)
	BlackboardAttribute (int attributeTypeID, String moduleName, String valueString)
	BlackboardAttribute (int attributeTypeID, String moduleName, String context, String valueString)
	BlackboardAttribute (int attributeTypeID, String moduleName, byte[] valueBytes)
	BlackboardAttribute (int attributeTypeID, String moduleName, String context, byte[] valueBytes)
boolean	equals (Object obj)
long	getArtifactID ()
String	getAttributeTypeDisplayName () throws TskCoreException
int	getAttributeTypeID ()
String	getAttributeTypeName () throws TskCoreException
String	getContext ()
String	getDisplayString ()
String	getModuleName ()
BlackboardArtifact	getParentArtifact () throws TskCoreException
byte[]	getValueBytes ()
double	getValueDouble ()
int	getValueInt ()
long	getValueLong ()
String	getValueString ()
TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE	getValueType ()
int	hashCode ()
String	toString ()

Protected Member Functions
void	setArtifactID (long artifactID)
void	setCase (SleuthkitCase sleuthkitCase)

Static Protected Attributes
final static char[]	hexArray = "0123456789ABCDEF".toCharArray()

Static Private Member Functions
static String	bytesToHexString (byte[] bytes)

Private Attributes
long	artifactID
int	attributeTypeID
String	context
String	moduleName
SleuthkitCase	sleuthkitCase
byte[]	valueBytes
double	valueDouble
int	valueInt
long	valueLong
String	valueString
TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE	valueType

Static Private Attributes
static ResourceBundle	bundle = ResourceBundle.getBundle("org.sleuthkit.datamodel.Bundle")

Detailed Description

Represents an attribute as stored in the Blackboard. Attributes are a name value pair. The name represents the type of data being stored. Attributes are grouped together into an Artifact as represented by a BlackboardArtifact object. This class is used to create attribute on the blackboard and is used to represent attribute queried from the blackboard.

Definition at line 30 of file BlackboardAttribute.java.

Constructor & Destructor Documentation

org.sleuthkit.datamodel.BlackboardAttribute.BlackboardAttribute	(	int	attributeTypeID,
		String	moduleName,
		int	valueInt
	)

Create a blackboard attribute that stores an int (creates an attribute that can be added to an artifact)

Parameters

attributeTypeID	type of the attribute
moduleName	name of the module that is creating the attribute
valueInt	the value

Definition at line 435 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.attributeTypeID, org.sleuthkit.datamodel.BlackboardAttribute.TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.INTEGER, org.sleuthkit.datamodel.BlackboardAttribute.moduleName, and org.sleuthkit.datamodel.BlackboardAttribute.valueInt.

org.sleuthkit.datamodel.BlackboardAttribute.BlackboardAttribute	(	int	attributeTypeID,
		String	moduleName,
		String	context,
		int	valueInt
	)

Create a blackboard attribute that stores an int (creates an attribute that can be added to an artifact)

Parameters

attributeTypeID	type of the attribute
moduleName	name of the module that is creating the attribute
context	extra information about the attribute
valueInt	the value

Deprecated:

context parameter will be deprecated - in lieu of specific blackboard attributes use the alternative constructor without context

Definition at line 461 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.attributeTypeID, org.sleuthkit.datamodel.BlackboardAttribute.context, org.sleuthkit.datamodel.BlackboardAttribute.moduleName, and org.sleuthkit.datamodel.BlackboardAttribute.valueInt.

org.sleuthkit.datamodel.BlackboardAttribute.BlackboardAttribute	(	int	attributeTypeID,
		String	moduleName,
		long	valueLong
	)

Create a blackboard attribute that stores a long (creates an attribute that can be added to an artifact)

Parameters

attributeTypeID	type of the attribute
moduleName	name of the module that is creating the attribute
valueLong	the value

Definition at line 475 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.attributeTypeID, org.sleuthkit.datamodel.BlackboardAttribute.TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.LONG, org.sleuthkit.datamodel.BlackboardAttribute.moduleName, and org.sleuthkit.datamodel.BlackboardAttribute.valueLong.

org.sleuthkit.datamodel.BlackboardAttribute.BlackboardAttribute	(	int	attributeTypeID,
		String	moduleName,
		String	context,
		long	valueLong
	)

Create a blackboard attribute that stores a long (creates an attribute that can be added to an artifact)

Parameters

attributeTypeID	type of the attribute
moduleName	name of the module that is creating the attribute
context	extra information about the attribute
valueLong	the value

Deprecated:

context parameter will be deprecated - in lieu of specific blackboard attributes use the alternative constructor without context

Definition at line 503 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.attributeTypeID, org.sleuthkit.datamodel.BlackboardAttribute.context, org.sleuthkit.datamodel.BlackboardAttribute.moduleName, and org.sleuthkit.datamodel.BlackboardAttribute.valueLong.

org.sleuthkit.datamodel.BlackboardAttribute.BlackboardAttribute	(	int	attributeTypeID,
		String	moduleName,
		double	valueDouble
	)

Create a blackboard attribute that stores a double (creates an attribute that can be added to an artifact)

Parameters

attributeTypeID	type of the attribute
moduleName	name of the module that is creating the attribute
valueDouble	the value

Definition at line 517 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.attributeTypeID, org.sleuthkit.datamodel.BlackboardAttribute.TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.DOUBLE, org.sleuthkit.datamodel.BlackboardAttribute.moduleName, and org.sleuthkit.datamodel.BlackboardAttribute.valueDouble.

org.sleuthkit.datamodel.BlackboardAttribute.BlackboardAttribute	(	int	attributeTypeID,
		String	moduleName,
		String	context,
		double	valueDouble
	)

Create a blackboard attribute that stores a double (creates an attribute that can be added to an artifact)

Parameters

attributeTypeID	type of the attribute
moduleName	name of the module that is creating the attribute
context	extra information about the attribute
valueDouble	the value

Deprecated:

context parameter will be deprecated - in lieu of specific blackboard attributes use the alternative constructor without context

Definition at line 544 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.attributeTypeID, org.sleuthkit.datamodel.BlackboardAttribute.context, org.sleuthkit.datamodel.BlackboardAttribute.moduleName, and org.sleuthkit.datamodel.BlackboardAttribute.valueDouble.

org.sleuthkit.datamodel.BlackboardAttribute.BlackboardAttribute	(	int	attributeTypeID,
		String	moduleName,
		String	valueString
	)

Create a blackboard attribute that stores a string (creates an attribute that can be added to an artifact)

Parameters

attributeTypeID	type of the attribute
moduleName	name of the module that is creating the attribute
valueString	the value

Definition at line 558 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.attributeTypeID, org.sleuthkit.datamodel.BlackboardAttribute.moduleName, org.sleuthkit.datamodel.BlackboardAttribute.TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.STRING, and org.sleuthkit.datamodel.BlackboardAttribute.valueString.

org.sleuthkit.datamodel.BlackboardAttribute.BlackboardAttribute	(	int	attributeTypeID,
		String	moduleName,
		String	context,
		String	valueString
	)

Create a blackboard attribute that stores a string (creates an attribute that can be added to an artifact)

Parameters

attributeTypeID	type of the attribute
moduleName	name of the module that is creating the attribute
context	extra information about the attribute
valueString	the value

Deprecated:

context parameter will be deprecated - in lieu of specific blackboard attributes use the alternative constructor without context

Definition at line 588 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.attributeTypeID, org.sleuthkit.datamodel.BlackboardAttribute.context, org.sleuthkit.datamodel.BlackboardAttribute.moduleName, and org.sleuthkit.datamodel.BlackboardAttribute.valueString.

org.sleuthkit.datamodel.BlackboardAttribute.BlackboardAttribute	(	int	attributeTypeID,
		String	moduleName,
		byte[]	valueBytes
	)

Create a blackboard attribute that stores a byte array (creates an attribute that can be added to an artifact)

Parameters

attributeTypeID	type of the attribute
moduleName	name of the module that is creating the attribute
valueBytes	the value

Definition at line 602 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.attributeTypeID, org.sleuthkit.datamodel.BlackboardAttribute.TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.BYTE, org.sleuthkit.datamodel.BlackboardAttribute.moduleName, and org.sleuthkit.datamodel.BlackboardAttribute.valueBytes.

org.sleuthkit.datamodel.BlackboardAttribute.BlackboardAttribute	(	int	attributeTypeID,
		String	moduleName,
		String	context,
		byte[]	valueBytes
	)

Create a blackboard attribute that stores a byte array (creates an attribute that can be added to an artifact)

Parameters

attributeTypeID	type of the attribute
moduleName	name of the module that is creating the attribute
context	extra information about the attribute
valueBytes	the value

Definition at line 629 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.attributeTypeID, org.sleuthkit.datamodel.BlackboardAttribute.context, org.sleuthkit.datamodel.BlackboardAttribute.moduleName, and org.sleuthkit.datamodel.BlackboardAttribute.valueBytes.

Member Function Documentation

static String org.sleuthkit.datamodel.BlackboardAttribute.bytesToHexString ( byte[]  bytes )

staticprivate

Definition at line 810 of file BlackboardAttribute.java.

Referenced by org.sleuthkit.datamodel.BlackboardAttribute.getDisplayString().

boolean org.sleuthkit.datamodel.BlackboardAttribute.equals

(

Object

obj

)

Definition at line 643 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.artifactID.

long org.sleuthkit.datamodel.BlackboardAttribute.getArtifactID

(

)

Get the artifact id

Returns

artifact id

Definition at line 667 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.artifactID.

String org.sleuthkit.datamodel.BlackboardAttribute.getAttributeTypeDisplayName

(

)

throws TskCoreException

Get the attribute type display name

Returns

type display name

Definition at line 694 of file BlackboardAttribute.java.

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

int org.sleuthkit.datamodel.BlackboardAttribute.getAttributeTypeID

(

)

Get the attribute type id

Returns

type id

Definition at line 676 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.attributeTypeID.

String org.sleuthkit.datamodel.BlackboardAttribute.getAttributeTypeName

(

)

throws TskCoreException

Get the attribute type name string

Returns

type name string

Definition at line 685 of file BlackboardAttribute.java.

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

String org.sleuthkit.datamodel.BlackboardAttribute.getContext

(

)

Get context of the data stored in the attribute, if set

Returns

context

Definition at line 769 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.context.

String org.sleuthkit.datamodel.BlackboardAttribute.getDisplayString

(

)

NOTE: Dates are not yet formatted.

Returns

return a string form of the stored value. Formatted if needed.

Definition at line 826 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.bytesToHexString(), org.sleuthkit.datamodel.BlackboardAttribute.getValueBytes(), org.sleuthkit.datamodel.BlackboardAttribute.getValueDouble(), org.sleuthkit.datamodel.BlackboardAttribute.getValueInt(), org.sleuthkit.datamodel.BlackboardAttribute.getValueLong(), org.sleuthkit.datamodel.BlackboardAttribute.getValueString(), and org.sleuthkit.datamodel.BlackboardAttribute.ATTRIBUTE_TYPE.TSK_READ_STATUS.

String org.sleuthkit.datamodel.BlackboardAttribute.getModuleName

(

)

Get module name of the module that created the attribute

Returns

name

Definition at line 760 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.moduleName.

BlackboardArtifact org.sleuthkit.datamodel.BlackboardAttribute.getParentArtifact

(

)

throws TskCoreException

Get the artifact that this attribute is associated with.

The artifact can be used to find the associated file and other attributes associated with this artifact.

Returns

artifact

Exceptions

TskException

exception thrown when critical error occurred within tsk core

Definition at line 784 of file BlackboardAttribute.java.

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

byte [] org.sleuthkit.datamodel.BlackboardAttribute.getValueBytes

(

)

Get value if it is a byte array

Returns

value

Definition at line 751 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.valueBytes.

Referenced by org.sleuthkit.datamodel.BlackboardAttribute.getDisplayString().

double org.sleuthkit.datamodel.BlackboardAttribute.getValueDouble

(

)

Get value if it is a double

Returns

value

Definition at line 733 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.valueDouble.

Referenced by org.sleuthkit.datamodel.BlackboardAttribute.getDisplayString().

int org.sleuthkit.datamodel.BlackboardAttribute.getValueInt

(

)

Get the value if it is an int

Returns

value

Definition at line 715 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.valueInt.

Referenced by org.sleuthkit.datamodel.BlackboardAttribute.getDisplayString().

long org.sleuthkit.datamodel.BlackboardAttribute.getValueLong

(

)

Get value if it is a long

Returns

value

Definition at line 724 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.valueLong.

Referenced by org.sleuthkit.datamodel.BlackboardAttribute.getDisplayString().

String org.sleuthkit.datamodel.BlackboardAttribute.getValueString

(

)

Get value if it is a string

Returns

value

Definition at line 742 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.valueString.

Referenced by org.sleuthkit.datamodel.BlackboardAttribute.getDisplayString().

TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE org.sleuthkit.datamodel.BlackboardAttribute.getValueType

(

)

Get the value type.

This should be used to identify the type of value and call the right value get method.

Returns

value type

Definition at line 706 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.valueType.

int org.sleuthkit.datamodel.BlackboardAttribute.hashCode

(

)

Definition at line 636 of file BlackboardAttribute.java.

void org.sleuthkit.datamodel.BlackboardAttribute.setArtifactID ( long  artifactID )

protected

Set the artifactID, this should only be used by sleuthkitCase

Parameters

artifactID

artifactID to set on a newly created attribute

Definition at line 793 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.artifactID.

void org.sleuthkit.datamodel.BlackboardAttribute.setCase ( SleuthkitCase  sleuthkitCase )

protected

Set the SleuthkitCase handle, this should only be used by SleuthkitCase on a newly created attribute

Parameters

sleuthkitCase

case handle to associated with this attribute

Definition at line 803 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.sleuthkitCase.

String org.sleuthkit.datamodel.BlackboardAttribute.toString

(

)

Definition at line 658 of file BlackboardAttribute.java.

Member Data Documentation

long org.sleuthkit.datamodel.BlackboardAttribute.artifactID

private

Definition at line 32 of file BlackboardAttribute.java.

Referenced by org.sleuthkit.datamodel.BlackboardAttribute.equals(), org.sleuthkit.datamodel.BlackboardAttribute.getArtifactID(), and org.sleuthkit.datamodel.BlackboardAttribute.setArtifactID().

int org.sleuthkit.datamodel.BlackboardAttribute.attributeTypeID

private

Definition at line 33 of file BlackboardAttribute.java.

Referenced by org.sleuthkit.datamodel.BlackboardAttribute.BlackboardAttribute(), and org.sleuthkit.datamodel.BlackboardAttribute.getAttributeTypeID().

ResourceBundle org.sleuthkit.datamodel.BlackboardAttribute.bundle = ResourceBundle.getBundle("org.sleuthkit.datamodel.Bundle")

staticprivate

Definition at line 43 of file BlackboardAttribute.java.

String org.sleuthkit.datamodel.BlackboardAttribute.context

private

Definition at line 35 of file BlackboardAttribute.java.

Referenced by org.sleuthkit.datamodel.BlackboardAttribute.BlackboardAttribute(), and org.sleuthkit.datamodel.BlackboardAttribute.getContext().

final static char [] org.sleuthkit.datamodel.BlackboardAttribute.hexArray = "0123456789ABCDEF".toCharArray()

staticprotected

Definition at line 808 of file BlackboardAttribute.java.

String org.sleuthkit.datamodel.BlackboardAttribute.moduleName

private

Definition at line 34 of file BlackboardAttribute.java.

Referenced by org.sleuthkit.datamodel.BlackboardAttribute.BlackboardAttribute(), and org.sleuthkit.datamodel.BlackboardAttribute.getModuleName().

SleuthkitCase org.sleuthkit.datamodel.BlackboardAttribute.sleuthkitCase

private

Definition at line 42 of file BlackboardAttribute.java.

Referenced by org.sleuthkit.datamodel.BlackboardAttribute.setCase().

byte [] org.sleuthkit.datamodel.BlackboardAttribute.valueBytes

private

Definition at line 41 of file BlackboardAttribute.java.

Referenced by org.sleuthkit.datamodel.BlackboardAttribute.BlackboardAttribute(), and org.sleuthkit.datamodel.BlackboardAttribute.getValueBytes().

double org.sleuthkit.datamodel.BlackboardAttribute.valueDouble

private

Definition at line 39 of file BlackboardAttribute.java.

Referenced by org.sleuthkit.datamodel.BlackboardAttribute.BlackboardAttribute(), and org.sleuthkit.datamodel.BlackboardAttribute.getValueDouble().

int org.sleuthkit.datamodel.BlackboardAttribute.valueInt

private

Definition at line 37 of file BlackboardAttribute.java.

Referenced by org.sleuthkit.datamodel.BlackboardAttribute.BlackboardAttribute(), and org.sleuthkit.datamodel.BlackboardAttribute.getValueInt().

long org.sleuthkit.datamodel.BlackboardAttribute.valueLong

private

Definition at line 38 of file BlackboardAttribute.java.

Referenced by org.sleuthkit.datamodel.BlackboardAttribute.BlackboardAttribute(), and org.sleuthkit.datamodel.BlackboardAttribute.getValueLong().

String org.sleuthkit.datamodel.BlackboardAttribute.valueString

private

Definition at line 40 of file BlackboardAttribute.java.

Referenced by org.sleuthkit.datamodel.BlackboardAttribute.BlackboardAttribute(), and org.sleuthkit.datamodel.BlackboardAttribute.getValueString().

TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE org.sleuthkit.datamodel.BlackboardAttribute.valueType

private

Definition at line 36 of file BlackboardAttribute.java.

Referenced by org.sleuthkit.datamodel.BlackboardAttribute.getValueType().

---

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

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