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

Classes

enum  ATTRIBUTE_TYPE
 
enum  TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE
 
class  Type
 

Public Member Functions

 BlackboardAttribute (ATTRIBUTE_TYPE attributeType, String source, int valueInt) throws IllegalArgumentException
 
 BlackboardAttribute (Type attributeType, String source, int valueInt) throws IllegalArgumentException
 
 BlackboardAttribute (ATTRIBUTE_TYPE attributeType, String source, long valueLong) throws IllegalArgumentException
 
 BlackboardAttribute (Type attributeType, String source, long valueLong) throws IllegalArgumentException
 
 BlackboardAttribute (ATTRIBUTE_TYPE attributeType, String source, double valueDouble) throws IllegalArgumentException
 
 BlackboardAttribute (Type attributeType, String source, double valueDouble) throws IllegalArgumentException
 
 BlackboardAttribute (ATTRIBUTE_TYPE attributeType, String source, String valueString) throws IllegalArgumentException
 
 BlackboardAttribute (Type attributeType, String source, String valueString) throws IllegalArgumentException
 
 BlackboardAttribute (ATTRIBUTE_TYPE attributeType, String source, byte[] valueBytes) throws IllegalArgumentException
 
 BlackboardAttribute (Type attributeType, String source, byte[] valueBytes) throws IllegalArgumentException
 
 BlackboardAttribute (int attributeTypeID, String moduleName, int valueInt) throws IllegalArgumentException
 
 BlackboardAttribute (int attributeTypeID, String moduleName, String context, int valueInt)
 
 BlackboardAttribute (int attributeTypeID, String moduleName, long valueLong) throws IllegalArgumentException
 
 BlackboardAttribute (int attributeTypeID, String moduleName, String context, long valueLong)
 
 BlackboardAttribute (int attributeTypeID, String moduleName, double valueDouble) throws IllegalArgumentException
 
 BlackboardAttribute (int attributeTypeID, String moduleName, String context, double valueDouble)
 
 BlackboardAttribute (int attributeTypeID, String moduleName, String valueString) throws IllegalArgumentException
 
 BlackboardAttribute (int attributeTypeID, String moduleName, String context, String valueString)
 
 BlackboardAttribute (int attributeTypeID, String moduleName, byte[] valueBytes) throws IllegalArgumentException
 
 BlackboardAttribute (int attributeTypeID, String moduleName, String context, byte[] valueBytes)
 
void addSource (String source) throws TskCoreException
 
boolean equals (Object obj)
 
long getArtifactID ()
 
BlackboardAttribute.Type getAttributeType ()
 
String getAttributeTypeDisplayName () throws TskCoreException
 
int getAttributeTypeID ()
 
String getAttributeTypeName () throws TskCoreException
 
String getContext ()
 
String getDisplayString ()
 
String getModuleName ()
 
BlackboardArtifact getParentArtifact () throws TskCoreException
 
List< String > getSources ()
 
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)
 

Private Member Functions

String replaceNulls (String text)
 

Private Attributes

long artifactID
 
BlackboardAttribute.Type attributeType
 
String context
 
SleuthkitCase sleuthkitCase
 
String sources
 
final byte[] valueBytes
 
final double valueDouble
 
final int valueInt
 
final long valueLong
 
final String valueString
 

Static Private Attributes

static final ResourceBundle bundle = ResourceBundle.getBundle("org.sleuthkit.datamodel.Bundle")
 
static final char[] HEX_ARRAY = "0123456789ABCDEF".toCharArray()
 

Detailed Description

Represents an attribute of an artifact posted to the blackboard. Instances should be constructed and then added to an instance of the BlackboardArtifact class.

Attributes are a name-value pairs. The name is the type of the attribute, as represented by the BlackboardAttribute.Type class. Standard attribute types are specified by the ATTRIBUTE_TYPE enumeration. Custom attribute types may be created by constructing a BlackboardAttribute.Type object and calling the SleuthkitCase.addArtifactAttributeType method. The BlackboardAttribute.Type object that is returned can then be used to create instances of the custom attribute by calling the appropriate BlackboardAttribute constructor. It can also be used to do blackboard queries involving the custom type.

Definition at line 42 of file BlackboardAttribute.java.

Constructor & Destructor Documentation

org.sleuthkit.datamodel.BlackboardAttribute.BlackboardAttribute ( ATTRIBUTE_TYPE  attributeType,
String  source,
int  valueInt 
) throws IllegalArgumentException

Constructs a standard attribute with an integer value. The attribute should be added to an appropriate artifact.

Parameters
attributeTypeThe standard attribute type.
sourceThe source of this attribute.
valueIntThe attribute value.
Exceptions
IllegalArgumentExceptionIf the value type of the specified standard attribute type is not TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.INTEGER.

Definition at line 816 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.attributeType, org.sleuthkit.datamodel.BlackboardAttribute.getValueType(), org.sleuthkit.datamodel.BlackboardAttribute.TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.INTEGER, org.sleuthkit.datamodel.BlackboardAttribute.replaceNulls(), and org.sleuthkit.datamodel.BlackboardAttribute.valueInt.

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

org.sleuthkit.datamodel.BlackboardAttribute.BlackboardAttribute ( Type  attributeType,
String  source,
int  valueInt 
) throws IllegalArgumentException

Constructs an attribute with an integer value. The attribute should be added to an appropriate artifact.

Parameters
attributeTypeThe attribute type.
sourceThe source of this attribute.
valueIntThe attribute value.
Exceptions
IllegalArgumentExceptionIf the value type of the specified attribute type is not TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.INTEGER.

Definition at line 843 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.attributeType, org.sleuthkit.datamodel.BlackboardAttribute.getValueType(), org.sleuthkit.datamodel.BlackboardAttribute.TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.INTEGER, org.sleuthkit.datamodel.BlackboardAttribute.replaceNulls(), and org.sleuthkit.datamodel.BlackboardAttribute.valueInt.

org.sleuthkit.datamodel.BlackboardAttribute.BlackboardAttribute ( ATTRIBUTE_TYPE  attributeType,
String  source,
long  valueLong 
) throws IllegalArgumentException

Constructs a standard attribute with a long/datetime value. If the value is a datetime, it should be seconds from January 1, 1970. The attribute should be added to an appropriate artifact.

Parameters
attributeTypeThe standard attribute type.
sourceThe source of this attribute.
valueLongThe attribute value.
Exceptions
IllegalArgumentExceptionIf the value type of the specified standard attribute type is not TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.LONG or TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.DATETIME.

Definition at line 873 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.attributeType, org.sleuthkit.datamodel.BlackboardAttribute.TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.DATETIME, org.sleuthkit.datamodel.BlackboardAttribute.getValueType(), org.sleuthkit.datamodel.BlackboardAttribute.TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.LONG, org.sleuthkit.datamodel.BlackboardAttribute.replaceNulls(), and org.sleuthkit.datamodel.BlackboardAttribute.valueLong.

org.sleuthkit.datamodel.BlackboardAttribute.BlackboardAttribute ( Type  attributeType,
String  source,
long  valueLong 
) throws IllegalArgumentException

Constructs an attribute with a long/datetime value. The attribute should be added to an appropriate artifact.

Parameters
attributeTypeThe attribute type.
sourceThe source of this attribute.
valueLongThe attribute value.
Exceptions
IllegalArgumentExceptionIf the value type of the specified standard attribute type is not TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.LONG or TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.DATETIME.

Definition at line 903 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.attributeType, org.sleuthkit.datamodel.BlackboardAttribute.TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.DATETIME, org.sleuthkit.datamodel.BlackboardAttribute.getValueType(), org.sleuthkit.datamodel.BlackboardAttribute.TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.LONG, org.sleuthkit.datamodel.BlackboardAttribute.replaceNulls(), and org.sleuthkit.datamodel.BlackboardAttribute.valueLong.

org.sleuthkit.datamodel.BlackboardAttribute.BlackboardAttribute ( ATTRIBUTE_TYPE  attributeType,
String  source,
double  valueDouble 
) throws IllegalArgumentException

Constructs a standard attribute with a double value. The attribute should be added to an appropriate artifact.

Parameters
attributeTypeThe standard attribute type.
sourceThe source of this attribute.
valueDoubleThe attribute value.
Exceptions
IllegalArgumentExceptionIf the value type of the specified standard attribute type is not TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.DOUBLE.

Definition at line 931 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.attributeType, org.sleuthkit.datamodel.BlackboardAttribute.TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.DOUBLE, org.sleuthkit.datamodel.BlackboardAttribute.getValueType(), org.sleuthkit.datamodel.BlackboardAttribute.replaceNulls(), and org.sleuthkit.datamodel.BlackboardAttribute.valueDouble.

org.sleuthkit.datamodel.BlackboardAttribute.BlackboardAttribute ( Type  attributeType,
String  source,
double  valueDouble 
) throws IllegalArgumentException

Constructs an attribute with a double value. The attribute should be added to an appropriate artifact.

Parameters
attributeTypeThe attribute type.
sourceThe source of this attribute.
valueDoubleThe attribute value.
Exceptions
IllegalArgumentExceptionIf the value type of the specified attribute type is not TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.DOUBLE.

Definition at line 959 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.attributeType, org.sleuthkit.datamodel.BlackboardAttribute.TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.DOUBLE, org.sleuthkit.datamodel.BlackboardAttribute.getValueType(), org.sleuthkit.datamodel.BlackboardAttribute.replaceNulls(), and org.sleuthkit.datamodel.BlackboardAttribute.valueDouble.

org.sleuthkit.datamodel.BlackboardAttribute.BlackboardAttribute ( ATTRIBUTE_TYPE  attributeType,
String  source,
String  valueString 
) throws IllegalArgumentException

Constructs a standard attribute with an string value. The attribute should be added to an appropriate artifact.

Parameters
attributeTypeThe standard attribute type.
sourceThe source of this attribute.
valueStringThe attribute value.
Exceptions
IllegalArgumentExceptionIf the value type of the specified standard attribute type is not TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.STRING.

Definition at line 986 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.attributeType, org.sleuthkit.datamodel.BlackboardAttribute.getValueType(), org.sleuthkit.datamodel.BlackboardAttribute.replaceNulls(), and org.sleuthkit.datamodel.BlackboardAttribute.TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.STRING.

org.sleuthkit.datamodel.BlackboardAttribute.BlackboardAttribute ( Type  attributeType,
String  source,
String  valueString 
) throws IllegalArgumentException

Constructs an attribute with a string value. The attribute should be added to an appropriate artifact.

Parameters
attributeTypeThe attribute type.
sourceThe source of this attribute.
valueStringThe attribute value.
Exceptions
IllegalArgumentExceptionIf the value type of the specified attribute type is not TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.STRING.

Definition at line 1017 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.attributeType, org.sleuthkit.datamodel.BlackboardAttribute.getValueType(), org.sleuthkit.datamodel.BlackboardAttribute.replaceNulls(), and org.sleuthkit.datamodel.BlackboardAttribute.TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.STRING.

org.sleuthkit.datamodel.BlackboardAttribute.BlackboardAttribute ( ATTRIBUTE_TYPE  attributeType,
String  source,
byte[]  valueBytes 
) throws IllegalArgumentException

Constructs a standard attribute with a byte array value. The attribute should be added to an appropriate artifact.

Parameters
attributeTypeThe standard attribute type.
sourceThe source of this attribute.
valueBytesThe attribute value.
Exceptions
IllegalArgumentExceptionIf the value type of the specified standard attribute type is not TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.BYTE.

Definition at line 1048 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.attributeType, org.sleuthkit.datamodel.BlackboardAttribute.TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.BYTE, org.sleuthkit.datamodel.BlackboardAttribute.getValueType(), org.sleuthkit.datamodel.BlackboardAttribute.replaceNulls(), and org.sleuthkit.datamodel.BlackboardAttribute.valueBytes.

org.sleuthkit.datamodel.BlackboardAttribute.BlackboardAttribute ( Type  attributeType,
String  source,
byte[]  valueBytes 
) throws IllegalArgumentException

Constructs an attribute with a byte array value. The attribute should be added to an appropriate artifact.

Parameters
attributeTypeThe attribute type.
sourceThe source of this attribute.
valueBytesThe attribute value.
Exceptions
IllegalArgumentExceptionIf the value type of the specified attribute type is not TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.BYTE.

Definition at line 1079 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.attributeType, org.sleuthkit.datamodel.BlackboardAttribute.TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.BYTE, org.sleuthkit.datamodel.BlackboardAttribute.getValueType(), org.sleuthkit.datamodel.BlackboardAttribute.replaceNulls(), and org.sleuthkit.datamodel.BlackboardAttribute.valueBytes.

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

Creates a standard attribute with an integer value. The attribute should be added to an appropriate artifact.

Parameters
attributeTypeIDThe standard attribute type id.
moduleNameThe display name of the module creating this attribute.
valueIntThe attribute value.
Exceptions
IllegalArgumentExceptionIf the value type of the specified standard attribute type is not TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.INTEGER or the type id is not for a standard type.
Deprecated:

Definition at line 1393 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.ATTRIBUTE_TYPE.fromID(), and org.sleuthkit.datamodel.BlackboardAttribute.valueInt.

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

Creates a standard attribute with an integer value. The attribute should be added to an appropriate artifact.

Parameters
attributeTypeIDThe standard attribute type id.
moduleNameThe display name of the module creating this attribute.
contextExtra information about the attribute.
valueIntThe attribute value.
Exceptions
IllegalArgumentExceptionIf the value type of the specified standard attribute type is not TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.INTEGER or the type id is not for a standard type.
Deprecated:

Definition at line 1415 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.replaceNulls(), and org.sleuthkit.datamodel.BlackboardAttribute.valueInt.

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

Creates a standard attribute with a long/datetime value. The attribute should be added to an appropriate artifact.

Parameters
attributeTypeIDThe standard attribute type id.
moduleNameThe display name of the module that creating this attribute.
valueLongThe attribute value.
Exceptions
IllegalArgumentExceptionIf the value type of the specified standard attribute type is not TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.LONG or TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.DATETIME or the type id is not for a standard type.

Definition at line 1439 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.ATTRIBUTE_TYPE.fromID(), and org.sleuthkit.datamodel.BlackboardAttribute.valueLong.

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

Creates a standard attribute with a long/datetime value. The attribute should be added to an appropriate artifact.

Parameters
attributeTypeIDThe standard attribute type id.
moduleNameThe display name of the module that creating this attribute.
contextExtra information about the attribute.
valueLongThe attribute value.
Exceptions
IllegalArgumentExceptionIf the value type of the specified standard attribute type is not TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.LONG or TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.DATETIME or the type id is not for a standard type.

Definition at line 1463 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.replaceNulls(), and org.sleuthkit.datamodel.BlackboardAttribute.valueLong.

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

Creates a standard attribute with a double value. The attribute should be added to an appropriate artifact.

Parameters
attributeTypeIDThe standard attribute type id.
moduleNameThe display name of the module creating this attribute.
valueDoubleThe attribute value.
Exceptions
IllegalArgumentExceptionIf the value type of the specified standard attribute type is not TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.DOUBLE or the type id is not for a standard type.
Deprecated:

Definition at line 1486 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.ATTRIBUTE_TYPE.fromID(), and org.sleuthkit.datamodel.BlackboardAttribute.valueDouble.

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

Creates a standard attribute with a double value. The attribute should be added to an appropriate artifact.

Parameters
attributeTypeIDThe standard attribute type id.
moduleNameThe display name of the module creating this attribute.
contextExtra information about the attribute.
valueDoubleThe attribute value.
Exceptions
IllegalArgumentExceptionIf the value type of the specified standard attribute type is not TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.DOUBLE or the type id is not for a standard type.
Deprecated:

Definition at line 1509 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.replaceNulls(), and org.sleuthkit.datamodel.BlackboardAttribute.valueDouble.

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

Creates a standard attribute with a string value. The attribute should be added to an appropriate artifact.

Parameters
attributeTypeIDThe standard attribute type id.
moduleNameThe display name of the module creating this attribute.
valueStringThe attribute value.
Exceptions
IllegalArgumentExceptionIf the value type of the specified standard attribute type is not TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.STRING or the type id is not for a standard type.
Deprecated:

Definition at line 1532 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.ATTRIBUTE_TYPE.fromID(), and org.sleuthkit.datamodel.BlackboardAttribute.valueString.

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

Creates a standard attribute with a string value. The attribute should be added to an appropriate artifact.

Parameters
attributeTypeIDThe standard attribute type id.
moduleNameThe display name of the module creating this attribute.
contextExtra information about the attribute.
valueStringThe attribute value.
Exceptions
IllegalArgumentExceptionIf the value type of the specified standard attribute type is not TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.STRING or the type id is not for a standard type.
Deprecated:

Definition at line 1554 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.replaceNulls(), and org.sleuthkit.datamodel.BlackboardAttribute.valueString.

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

Creates a standard attribute with a byte array value. The attribute should be added to an appropriate artifact.

Parameters
attributeTypeIDThe standard attribute type id.
moduleNameThe display name of the module creating this attribute.
valueBytesThe attribute value.
Exceptions
IllegalArgumentExceptionIf the value type of the specified standard attribute type is not TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.BYTE or the type id is not for a standard type.
Deprecated:

Definition at line 1577 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.ATTRIBUTE_TYPE.fromID(), and org.sleuthkit.datamodel.BlackboardAttribute.valueBytes.

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

Creates a standard attribute with a byte array value. The attribute should be added to an appropriate artifact.

Parameters
attributeTypeIDThe standard attribute type id.
moduleNameThe display name of the module creating this attribute.
contextExtra information about the attribute.
valueBytesThe attribute value.
Exceptions
IllegalArgumentExceptionIf the value type of the specified standard attribute type is not TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.BYTE or the type id is not for a standard type.
Deprecated:

Definition at line 1599 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.replaceNulls(), and org.sleuthkit.datamodel.BlackboardAttribute.valueBytes.

Member Function Documentation

void org.sleuthkit.datamodel.BlackboardAttribute.addSource ( String  source) throws TskCoreException

Adds a source to the sources of this attribute.

Parameters
sourceThe source name.
Exceptions
org.sleuthkit.datamodel.TskCoreException

Definition at line 1198 of file BlackboardAttribute.java.

boolean org.sleuthkit.datamodel.BlackboardAttribute.equals ( Object  obj)
long org.sleuthkit.datamodel.BlackboardAttribute.getArtifactID ( )

Gets the id of the artifact associated with this attribute, if the attribute was added to an artifact. Attributes should always be added to artifacts after they are constructed.

Returns
The artifact id or zero if the artifact id has not been set.

Definition at line 1105 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.artifactID.

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

BlackboardAttribute.Type org.sleuthkit.datamodel.BlackboardAttribute.getAttributeType ( )

Gets the type of this attribute.

Returns
The attribute type.

Definition at line 1114 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.attributeType.

String org.sleuthkit.datamodel.BlackboardAttribute.getAttributeTypeDisplayName ( ) throws TskCoreException

Gets the attribute type display name.

Returns
type The display name.
Exceptions
org.sleuthkit.datamodel.TskCoreException
Deprecated:
Use BlackboardAttribute.getAttributeType.getDisplayName instead.

Definition at line 1697 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.attributeType.

int org.sleuthkit.datamodel.BlackboardAttribute.getAttributeTypeID ( )

Gets the attribute type id.

Returns
The type id.
Deprecated:
Use BlackboardAttribute.getAttributeType.getTypeID instead.

Definition at line 1668 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.attributeType.

String org.sleuthkit.datamodel.BlackboardAttribute.getAttributeTypeName ( ) throws TskCoreException

Gets the attribute type name.

Returns
The type name.
Exceptions
org.sleuthkit.datamodel.TskCoreException
Deprecated:
Use BlackboardAttribute.getAttributeType.getTypeName instead.

Definition at line 1682 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.attributeType.

String org.sleuthkit.datamodel.BlackboardAttribute.getContext ( )

Gets the context of this attribute.

Returns
The context, may be the empty string.
Deprecated:
Setting context for an attribute is deprecated.

Definition at line 1644 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.context.

String org.sleuthkit.datamodel.BlackboardAttribute.getModuleName ( )

Gets the name of the first module identified as a sources of this attribute.

Returns
A comma-separated-values list of module names, may be empty.
Deprecated:
Use getSources instead.

Definition at line 1710 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.sources.

BlackboardArtifact org.sleuthkit.datamodel.BlackboardAttribute.getParentArtifact ( ) throws TskCoreException

Gets the artifact associated with this attribute. The artifact can be used to get the source content for the artifact as well as any other attributes associated with the artifact.

Returns
The artifact.
Exceptions
TskCoreExceptionIf there is no artifact associated with this attribute or there is an error reading from the case database.

Definition at line 1213 of file BlackboardAttribute.java.

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

List<String> org.sleuthkit.datamodel.BlackboardAttribute.getSources ( )

Gets the sources of this attribute.

Returns
A list of sources, may be empty.

Definition at line 1182 of file BlackboardAttribute.java.

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

Gets the value of this attribute. The value is only valid if the attribute value type is TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.BYTE.

Returns
The attribute value.

Definition at line 1173 of file BlackboardAttribute.java.

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

double org.sleuthkit.datamodel.BlackboardAttribute.getValueDouble ( )

Gets the value of this attribute. The value is only valid if the attribute value type is TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.DOUBLE.

Returns
The attribute value.

Definition at line 1153 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.valueDouble.

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

int org.sleuthkit.datamodel.BlackboardAttribute.getValueInt ( )

Gets the value of this attribute. The value is only valid if the attribute value type is TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.INTEGER.

Returns
The attribute value.

Definition at line 1133 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.valueInt.

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

long org.sleuthkit.datamodel.BlackboardAttribute.getValueLong ( )

Gets the value of this attribute. The value is only valid if the attribute value type is TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.LONG.

Returns
The attribute value.

Definition at line 1143 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.valueLong.

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

String org.sleuthkit.datamodel.BlackboardAttribute.getValueString ( )

Gets the value of this attribute. The value is only valid if the attribute value type is TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.STRING.

Returns
The attribute value.

Definition at line 1163 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.valueString.

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

int org.sleuthkit.datamodel.BlackboardAttribute.hashCode ( )

Definition at line 1218 of file BlackboardAttribute.java.

String org.sleuthkit.datamodel.BlackboardAttribute.replaceNulls ( String  text)
private

Replace all NUL characters in the string with the SUB character

Parameters
textThe input string.
Returns
The output string.

Definition at line 1372 of file BlackboardAttribute.java.

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

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

Sets the artifact id.

Parameters
artifactIDThe artifact id.
Deprecated:
The preferred method for doing this is to add the attribute to a BlackboardArtifact object by calling BlackboardArtifact.addAttribute or BlackboardArtifact.addAttributes, both of which post the attributes to the blackboard.

Definition at line 1616 of file BlackboardAttribute.java.

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

Sets the reference to the SleuthkitCase object that represents the case database.

Parameters
sleuthkitCaseA reference to a SleuthkitCase object.
Deprecated:
The preferred method for doing this is to add the attribute to a BlackboardArtifact object by calling BlackboardArtifact.addAttribute or BlackboardArtifact.addAttributes, both of which post the attributes to the blackboard.

Definition at line 1632 of file BlackboardAttribute.java.

String org.sleuthkit.datamodel.BlackboardAttribute.toString ( )

Member Data Documentation

long org.sleuthkit.datamodel.BlackboardAttribute.artifactID
private
final ResourceBundle org.sleuthkit.datamodel.BlackboardAttribute.bundle = ResourceBundle.getBundle("org.sleuthkit.datamodel.Bundle")
staticprivate

Definition at line 45 of file BlackboardAttribute.java.

String org.sleuthkit.datamodel.BlackboardAttribute.context
private
final char [] org.sleuthkit.datamodel.BlackboardAttribute.HEX_ARRAY = "0123456789ABCDEF".toCharArray()
staticprivate

Definition at line 44 of file BlackboardAttribute.java.

SleuthkitCase org.sleuthkit.datamodel.BlackboardAttribute.sleuthkitCase
private

Definition at line 54 of file BlackboardAttribute.java.

String org.sleuthkit.datamodel.BlackboardAttribute.sources
private
final byte [] org.sleuthkit.datamodel.BlackboardAttribute.valueBytes
private
final double org.sleuthkit.datamodel.BlackboardAttribute.valueDouble
private
final int org.sleuthkit.datamodel.BlackboardAttribute.valueInt
private
final long org.sleuthkit.datamodel.BlackboardAttribute.valueLong
private
final String org.sleuthkit.datamodel.BlackboardAttribute.valueString
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.