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

Inherits org.sleuthkit.datamodel.SleuthkitVisitableItem.


enum  ReviewStatus
class  Type

Public Member Functions

void addAttribute (BlackboardAttribute attr) throws TskCoreException
void addAttributes (Collection< BlackboardAttribute > attributes) throws TskCoreException
boolean equals (Object obj)
long getArtifactID ()
int getArtifactTypeID ()
String getArtifactTypeName ()
BlackboardAttribute getAttribute (BlackboardAttribute.Type attributeType) throws TskCoreException
List< BlackboardAttributegetAttributes () throws TskCoreException
List< BlackboardAttributegetAttributes (final BlackboardAttribute.ATTRIBUTE_TYPE attributeType) throws TskCoreException
String getDisplayName ()
long getObjectID ()
ReviewStatus getReviewStatus ()
SleuthkitCase getSleuthkitCase ()
int hashCode ()
String toString ()

Protected Member Functions

 BlackboardArtifact (SleuthkitCase sleuthkitCase, long artifactID, long objID, int artifactTypeID, String artifactTypeName, String displayName)

Private Attributes

final long artifactID
final int artifactTypeID
final String artifactTypeName
final List< BlackboardAttributeattrsCache = new ArrayList<BlackboardAttribute>()
final String displayName
boolean loadedCacheFromDb = false
final long objID
final ReviewStatus reviewStatus
final SleuthkitCase sleuthkitCase

Static Private Attributes

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

Detailed Description

Represents an artifact as stored in the Blackboard. Artifacts are a collection of name value pairs and have a type that represents the type of data they are storing. This class is used to create artifacts on the blackboard and is used to represent artifacts queried from the blackboard.

Definition at line 36 of file

Constructor & Destructor Documentation

org.sleuthkit.datamodel.BlackboardArtifact.BlackboardArtifact ( SleuthkitCase  sleuthkitCase,
long  artifactID,
long  objID,
int  artifactTypeID,
String  artifactTypeName,
String  displayName 

Constructor for an artifact. Should only be used by SleuthkitCase. Sets the initial review status as "undecided"

sleuthkitCasethe case that can be used to access the database this artifact is part of
artifactIDthe id for this artifact
objIDthe object this artifact is associated with
artifactTypeIDthe type id of this artifact
artifactTypeNamethe type name of this artifact
displayNamethe display name of this artifact
use new BlackboardArtifact(SleuthkitCase, long, long, int, String, String, ReviewStatus) instead

Definition at line 645 of file

References org.sleuthkit.datamodel.BlackboardArtifact.artifactID, org.sleuthkit.datamodel.BlackboardArtifact.artifactTypeID, org.sleuthkit.datamodel.BlackboardArtifact.artifactTypeName, org.sleuthkit.datamodel.BlackboardArtifact.displayName, org.sleuthkit.datamodel.BlackboardArtifact.objID, org.sleuthkit.datamodel.BlackboardArtifact.sleuthkitCase, and org.sleuthkit.datamodel.BlackboardArtifact.ReviewStatus.UNDECIDED.

Member Function Documentation

void org.sleuthkit.datamodel.BlackboardArtifact.addAttribute ( BlackboardAttribute  attr) throws TskCoreException

Add an attribute to this artifact

attrthe attribute to add
TskCoreExceptionif a critical error occurs and the attribute was not added

Definition at line 415 of file

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

void org.sleuthkit.datamodel.BlackboardArtifact.addAttributes ( Collection< BlackboardAttribute attributes) throws TskCoreException

Add a collection of attributes to this artifact in a single transaction (faster than individually)

attributesList of attributes to add
TskCoreExceptionif a critical error occurs and the attribute was not added

Definition at line 431 of file

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

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

Get the id for this artifact


Definition at line 367 of file

References org.sleuthkit.datamodel.BlackboardArtifact.artifactID.

Referenced by org.sleuthkit.datamodel.SleuthkitCase.setReviewStatus().

int org.sleuthkit.datamodel.BlackboardArtifact.getArtifactTypeID ( )

Get the artifact type id for this artifact

artifact type id

Definition at line 385 of file

References org.sleuthkit.datamodel.BlackboardArtifact.artifactTypeID.

String org.sleuthkit.datamodel.BlackboardArtifact.getArtifactTypeName ( )

Get the artifact type name for this artifact

artifact type name

Definition at line 394 of file

References org.sleuthkit.datamodel.BlackboardArtifact.artifactTypeName.

BlackboardAttribute org.sleuthkit.datamodel.BlackboardArtifact.getAttribute ( BlackboardAttribute.Type  attributeType) throws TskCoreException

Gets the attribute of this artifact of given type.

attributeTypeThe type of attribute to get
The attribute of that type, returns null if there is no attribute of that type.
TskCoreExceptionif a critical error occurs and the attributes are not fetched

Definition at line 503 of file

References org.sleuthkit.datamodel.BlackboardArtifact.getAttributes().

List<BlackboardAttribute> org.sleuthkit.datamodel.BlackboardArtifact.getAttributes ( ) throws TskCoreException

Gets all attributes associated with this artifact

a list of attributes
TskCoreExceptionif a critical error occurs and the attributes are not fetched

Definition at line 452 of file

References org.sleuthkit.datamodel.BlackboardArtifact.attrsCache, and org.sleuthkit.datamodel.SleuthkitCase.getBlackboardAttributes().

Referenced by org.sleuthkit.datamodel.BlackboardArtifact.getAttribute(), and org.sleuthkit.datamodel.AbstractContent.getGenInfoAttributes().

List<BlackboardAttribute> org.sleuthkit.datamodel.BlackboardArtifact.getAttributes ( final BlackboardAttribute.ATTRIBUTE_TYPE  attributeType) throws TskCoreException

Gets all attributes associated with this artifact that are of the given attribute type.

attributeTypethe type of attributes to get
a list of attributes of the given type
TskCoreExceptionif a critical error occurs and the attributes are not fetched
There should not be multiple attributes of a type on an artifact. Use getAttribute(BlackboardAttribute.Type) instead.

Definition at line 476 of file

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

String org.sleuthkit.datamodel.BlackboardArtifact.getDisplayName ( )

Get the artifact display name for this artifact

artifact display name

Definition at line 403 of file

References org.sleuthkit.datamodel.BlackboardArtifact.displayName.

long org.sleuthkit.datamodel.BlackboardArtifact.getObjectID ( )
ReviewStatus org.sleuthkit.datamodel.BlackboardArtifact.getReviewStatus ( )
SleuthkitCase org.sleuthkit.datamodel.BlackboardArtifact.getSleuthkitCase ( )

Gets the SleuthkitCase handle associated with this object

the case handle

Definition at line 532 of file

References org.sleuthkit.datamodel.BlackboardArtifact.sleuthkitCase.

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

Definition at line 552 of file

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

Definition at line 559 of file

Member Data Documentation

final int org.sleuthkit.datamodel.BlackboardArtifact.artifactTypeID
final String org.sleuthkit.datamodel.BlackboardArtifact.artifactTypeName
final List<BlackboardAttribute> org.sleuthkit.datamodel.BlackboardArtifact.attrsCache = new ArrayList<BlackboardAttribute>()
final ResourceBundle org.sleuthkit.datamodel.BlackboardArtifact.bundle = ResourceBundle.getBundle("org.sleuthkit.datamodel.Bundle")

Definition at line 38 of file

boolean org.sleuthkit.datamodel.BlackboardArtifact.loadedCacheFromDb = false

Definition at line 313 of file

final long org.sleuthkit.datamodel.BlackboardArtifact.objID
final ReviewStatus org.sleuthkit.datamodel.BlackboardArtifact.reviewStatus
final SleuthkitCase org.sleuthkit.datamodel.BlackboardArtifact.sleuthkitCase

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.