org.sleuthkit.autopsy.casemodule.services.Blackboard Class Reference

Inherits Closeable.

Classes
class	BlackboardException

Public Member Functions
synchronized void	close () throws IOException
synchronized BlackboardArtifact.Type	getOrAddArtifactType (String typeName, String displayName) throws BlackboardException
synchronized BlackboardAttribute.Type	getOrAddAttributeType (String typeName, BlackboardAttribute.TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE valueType, String displayName) throws BlackboardException
synchronized void	indexArtifact (BlackboardArtifact artifact) throws BlackboardException

Private Attributes
SleuthkitCase	caseDb

Detailed Description

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

NOTE: This API of this class is under development.

Definition at line 38 of file Blackboard.java.

Member Function Documentation

synchronized void org.sleuthkit.autopsy.casemodule.services.Blackboard.close

(

)

throws IOException

Closes the blackboard.

Exceptions

IOException

If there is a problem closing the blackboard.

Definition at line 139 of file Blackboard.java.

synchronized BlackboardArtifact.Type org.sleuthkit.autopsy.casemodule.services.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

BlackboardBlackboardException

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

Definition at line 86 of file Blackboard.java.

synchronized BlackboardAttribute.Type org.sleuthkit.autopsy.casemodule.services.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

BlackboardBlackboardException

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

Definition at line 116 of file Blackboard.java.

synchronized void org.sleuthkit.autopsy.casemodule.services.Blackboard.indexArtifact

(

BlackboardArtifact

artifact

)

throws BlackboardException

Indexes the text associated with the an artifact.

Parameters

artifact

The artifact to be indexed.

Exceptions

BlackboardException

If there is a problem indexing the artifact.

Definition at line 59 of file Blackboard.java.

References org.sleuthkit.autopsy.keywordsearchservice.KeywordSearchService.index().

Referenced by org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.addArtifact(), org.sleuthkit.autopsy.modules.filetypeid.FileTypeIdIngestModule.createInterestingFileHit(), org.sleuthkit.autopsy.centralrepository.eventlisteners.IngestEventsListener.postCorrelatedBadArtifactToBlackboard(), org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.postHashSetHitToBlackboard(), org.sleuthkit.autopsy.modules.fileextmismatch.FileExtMismatchIngestModule.process(), and org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.processPst().

Member Data Documentation

SleuthkitCase org.sleuthkit.autopsy.casemodule.services.Blackboard.caseDb

private

Definition at line 40 of file Blackboard.java.

---

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

• /home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/casemodule/services/Blackboard.java