Classes
class	ArtifactsPostedEvent

class	BlackboardException

Public Member Functions
boolean	artifactExists (Content content, BlackboardArtifact.ARTIFACT_TYPE artifactType, Collection< BlackboardAttribute > attributesList) throws TskCoreException

List< BlackboardArtifact >	getArtifacts (int artifactTypeID, long dataSourceObjId) throws TskCoreException

long	getArtifactsCount (int artifactTypeID, long dataSourceObjId) throws TskCoreException

List< BlackboardArtifact.Type >	getArtifactTypesInUse (long dataSourceObjId) throws TskCoreException

BlackboardArtifact.Type	getOrAddArtifactType (String typeName, String displayName) throws BlackboardException

BlackboardAttribute.Type	getOrAddAttributeType (String typeName, BlackboardAttribute.TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE valueType, String displayName) throws BlackboardException

void	postArtifact (BlackboardArtifact artifact, String moduleName) throws BlackboardException

void	postArtifacts (Collection< BlackboardArtifact > artifacts, String moduleName) throws BlackboardException

Detailed Description

A representation of the blackboard, a place where artifacts and their attributes are posted.

Definition at line 39 of file Blackboard.java.

Member Function Documentation

boolean org.sleuthkit.datamodel.Blackboard.artifactExists	(	Content	content,
		BlackboardArtifact.ARTIFACT_TYPE	artifactType,
		Collection< BlackboardAttribute >	attributesList
	)		throws TskCoreException

Definition at line 274 of file Blackboard.java.

List<BlackboardArtifact> org.sleuthkit.datamodel.Blackboard.getArtifacts	(	int	artifactTypeID,
		long	dataSourceObjId
	)		throws TskCoreException

Get all blackboard artifacts of a given type. Does not included rejected artifacts.

Parameters

artifactTypeID	artifact type to get
dataSourceObjId	data source to look under

Returns: list of blackboard artifacts

Exceptions

TskCoreException exception thrown if a critical error occurs within TSK core

Definition at line 221 of file Blackboard.java.

long org.sleuthkit.datamodel.Blackboard.getArtifactsCount	(	int	artifactTypeID,
		long	dataSourceObjId
	)		throws TskCoreException

Get count of all blackboard artifacts of a given type for the given data source. Does not include rejected artifacts.

Parameters

artifactTypeID	artifact type id (must exist in database)
dataSourceObjId	data source object id

Returns: count of blackboard artifacts

Exceptions

TskCoreException exception thrown if a critical error occurs within TSK core

Definition at line 204 of file Blackboard.java.

List<BlackboardArtifact.Type> org.sleuthkit.datamodel.Blackboard.getArtifactTypesInUse ( long dataSourceObjId ) throws TskCoreException

Gets the list of all artifact types in use for the given data source. Gets both standard and custom types.

Parameters

dataSourceObjId data source object id

Returns: The list of artifact types

Exceptions

TskCoreException exception thrown if a critical error occurred within tsk core

Definition at line 165 of file Blackboard.java.

References org.sleuthkit.datamodel.SleuthkitCase.acquireSingleUserCaseReadLock(), and org.sleuthkit.datamodel.SleuthkitCase.releaseSingleUserCaseReadLock().

BlackboardArtifact.Type org.sleuthkit.datamodel.Blackboard.getOrAddArtifactType	(	String	typeName,
		String	displayName
	)		throws BlackboardException

Gets an artifact type, creating it if it does not already exist. Use this method to define custom artifact types.

Parameters

typeName	The type name of the artifact type.
displayName	The display name of the artifact type.

Returns: A type object representing the artifact type.

Exceptions

BlackboardException If there is a problem getting or adding the artifact type.

Definition at line 111 of file Blackboard.java.

References org.sleuthkit.datamodel.SleuthkitCase.addBlackboardArtifactType(), and org.sleuthkit.datamodel.SleuthkitCase.getArtifactType().

BlackboardAttribute.Type org.sleuthkit.datamodel.Blackboard.getOrAddAttributeType	(	String	typeName,
		BlackboardAttribute.TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE	valueType,
		String	displayName
	)		throws BlackboardException

Gets an attribute type, creating it if it does not already exist. Use this method to define custom attribute types.

Parameters

typeName	The type name of the attribute type.
valueType	The value type of the attribute type.
displayName	The display name of the attribute type.

Returns: A type object representing the attribute type.

Exceptions

BlackboardException If there is a problem getting or adding the attribute type.

Definition at line 139 of file Blackboard.java.

References org.sleuthkit.datamodel.SleuthkitCase.addArtifactAttributeType(), and org.sleuthkit.datamodel.SleuthkitCase.getAttributeType().

void org.sleuthkit.datamodel.Blackboard.postArtifact	(	BlackboardArtifact	artifact,
		String	moduleName
	)		throws BlackboardException

Posts the artifact. The artifact should be complete (all attributes have been added) before being posted. Posting the artifact includes making any timeline events that may be derived from it, and broadcasting a notification that the artifact is ready for further analysis.

Parameters

artifact	The artifact to be posted.
moduleName	The name of the module that is posting the artifacts.

Exceptions

BlackboardException If there is a problem posting the artifact.

Definition at line 64 of file Blackboard.java.

References org.sleuthkit.datamodel.Blackboard.postArtifacts().

void org.sleuthkit.datamodel.Blackboard.postArtifacts	(	Collection< BlackboardArtifact >	artifacts,
		String	moduleName
	)		throws BlackboardException

Posts a Collection of artifacts. The artifacts should be complete (all attributes have been added) before being posted. Posting the artifacts includes making any events that may be derived from them, and broadcasting notifications that the artifacts are ready for further analysis.

Parameters

artifacts	The artifacts to be posted .
moduleName	The name of the module that is posting the artifacts.

Exceptions

BlackboardException If there is a problem posting the artifacts.

Definition at line 83 of file Blackboard.java.

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

Referenced by org.sleuthkit.datamodel.Blackboard.postArtifact().

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

/home/carriersleuth/repos/sleuthkit/bindings/java/src/org/sleuthkit/datamodel/Blackboard.java

Classes

Public Member Functions

Detailed Description

Member Function Documentation