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

Inherits org.sleuthkit.datamodel.AbstractAttribute.

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 that)
 
long getArtifactID ()
 
String getAttributeTypeDisplayName () throws TskCoreException
 
int getAttributeTypeID ()
 
String getAttributeTypeName () throws TskCoreException
 
String getContext ()
 
String getDisplayString ()
 
String getModuleName ()
 
BlackboardArtifact getParentArtifact () throws TskCoreException
 
List< String > getSources ()
 
int hashCode ()
 
String toString ()
 
- Public Member Functions inherited from org.sleuthkit.datamodel.AbstractAttribute
 AbstractAttribute (BlackboardAttribute.Type attributeType, int valueInt)
 
 AbstractAttribute (BlackboardAttribute.Type attributeType, long valueLong)
 
 AbstractAttribute (BlackboardAttribute.Type attributeType, double valueDouble)
 
 AbstractAttribute (BlackboardAttribute.Type attributeType, String valueString)
 
 AbstractAttribute (BlackboardAttribute.Type attributeType, byte[] valueBytes)
 
BlackboardAttribute.Type getAttributeType ()
 
String getDisplayString ()
 
byte[] getValueBytes ()
 
double getValueDouble ()
 
int getValueInt ()
 
long getValueLong ()
 
String getValueString ()
 
BlackboardAttribute.TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE getValueType ()
 

Protected Member Functions

void setArtifactID (long artifactID)
 
void setCase (SleuthkitCase sleuthkitCase)
 

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 45 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 76 of file BlackboardAttribute.java.

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 94 of file BlackboardAttribute.java.

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 115 of file BlackboardAttribute.java.

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 135 of file BlackboardAttribute.java.

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 153 of file BlackboardAttribute.java.

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 171 of file BlackboardAttribute.java.

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 or TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.JSON

Definition at line 191 of file BlackboardAttribute.java.

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 209 of file BlackboardAttribute.java.

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 227 of file BlackboardAttribute.java.

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 245 of file BlackboardAttribute.java.

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 1671 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.ATTRIBUTE_TYPE.fromID().

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 1693 of file BlackboardAttribute.java.

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.
Deprecated:

Definition at line 1718 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.ATTRIBUTE_TYPE.fromID().

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.
Deprecated:

Definition at line 1743 of file BlackboardAttribute.java.

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 1766 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.ATTRIBUTE_TYPE.fromID().

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 1789 of file BlackboardAttribute.java.

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 1812 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.ATTRIBUTE_TYPE.fromID().

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 1834 of file BlackboardAttribute.java.

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 1857 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.ATTRIBUTE_TYPE.fromID().

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 1879 of file BlackboardAttribute.java.

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 292 of file BlackboardAttribute.java.

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 258 of file BlackboardAttribute.java.

Referenced by org.sleuthkit.datamodel.BlackboardAttribute.getParentArtifact(), and org.sleuthkit.datamodel.BlackboardAttribute.toString().

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 1977 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.AbstractAttribute.getAttributeType().

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

Gets the attribute type id.

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

Definition at line 1948 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.AbstractAttribute.getAttributeType().

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 1962 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.AbstractAttribute.getAttributeType().

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 1924 of file BlackboardAttribute.java.

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

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 1990 of file BlackboardAttribute.java.

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 307 of file BlackboardAttribute.java.

References org.sleuthkit.datamodel.BlackboardAttribute.getArtifactID(), and org.sleuthkit.datamodel.SleuthkitCase.getBlackboardArtifact().

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

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

Gets the sources of this attribute.

Returns
A list of sources, may be empty.

Definition at line 276 of file BlackboardAttribute.java.

Referenced by org.sleuthkit.datamodel.BlackboardAttribute.equals(), org.sleuthkit.datamodel.BlackboardAttribute.hashCode(), and org.sleuthkit.datamodel.BlackboardAttribute.toString().

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 1896 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 1912 of file BlackboardAttribute.java.


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

Copyright © 2011-2021 Brian Carrier. (carrier -at- sleuthkit -dot- org)
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.