Inherits Closeable.

Classes
class	TagNameAlreadyExistsException

Public Member Functions
BlackboardArtifactTag	addBlackboardArtifactTag (BlackboardArtifact artifact, TagName tagName) throws TskCoreException

BlackboardArtifactTag	addBlackboardArtifactTag (BlackboardArtifact artifact, TagName tagName, String comment) throws TskCoreException

ContentTag	addContentTag (Content content, TagName tagName) throws TskCoreException

ContentTag	addContentTag (Content content, TagName tagName, String comment) throws TskCoreException

ContentTag	addContentTag (Content content, TagName tagName, String comment, long beginByteOffset, long endByteOffset) throws TskCoreException

synchronized TagName	addTagName (String displayName) throws TagNameAlreadyExistsException, TskCoreException

synchronized TagName	addTagName (String displayName, String description) throws TagNameAlreadyExistsException, TskCoreException

synchronized TagName	addTagName (String displayName, String description, TagName.HTML_COLOR color) throws TagNameAlreadyExistsException, TskCoreException

synchronized TagName	addTagName (String displayName, String description, TagName.HTML_COLOR color, TskData.FileKnown knownStatus) throws TagNameAlreadyExistsException, TskCoreException

void	close () throws IOException

void	deleteBlackboardArtifactTag (BlackboardArtifactTag tag) throws TskCoreException

void	deleteContentTag (ContentTag tag) throws TskCoreException

List< BlackboardArtifactTag >	getAllBlackboardArtifactTags () throws TskCoreException

List< ContentTag >	getAllContentTags () throws TskCoreException

List< TagName >	getAllTagNames () throws TskCoreException

BlackboardArtifactTag	getBlackboardArtifactTagByTagID (long tagId) throws TskCoreException

List< BlackboardArtifactTag >	getBlackboardArtifactTagsByArtifact (BlackboardArtifact artifact) throws TskCoreException

List< BlackboardArtifactTag >	getBlackboardArtifactTagsByTagName (TagName tagName) throws TskCoreException

long	getBlackboardArtifactTagsCountByTagName (TagName tagName) throws TskCoreException

ContentTag	getContentTagByTagID (long tagId) throws TskCoreException

List< ContentTag >	getContentTagsByContent (Content content) throws TskCoreException

List< ContentTag >	getContentTagsByTagName (TagName tagName) throws TskCoreException

long	getContentTagsCountByTagName (TagName tagName) throws TskCoreException

Map< String, TagName >	getDisplayNamesToTagNamesMap () throws TskCoreException

List< TagName >	getTagNamesInUse () throws TskCoreException

boolean	tagNameExists (String tagDisplayName)

Static Public Member Functions
static boolean	containsIllegalCharacters (String tagDisplayName)

static List< String >	getNotableTagDisplayNames ()

static String	getNotableTagLabel ()

static List< String >	getStandardTagNames ()

static Set< String >	getTagDisplayNames () throws TskCoreException

Private Attributes
final SleuthkitCase	caseDb

Static Private Attributes
static final Logger	LOGGER = Logger.getLogger(TagsManager.class.getName())

Detailed Description

A per case Autopsy service that manages the addition of content and artifact tags to the case database.

Definition at line 47 of file TagsManager.java.

Member Function Documentation

BlackboardArtifactTag org.sleuthkit.autopsy.casemodule.services.TagsManager.addBlackboardArtifactTag	(	BlackboardArtifact	artifact,
		TagName	tagName
	)		throws TskCoreException

Tags an artifact.

Parameters

artifact	The artifact to tag.
tagName	The representation of the desired tag type in the case database, which can be obtained by calling getTagNames and/or addTagName.

Returns: A BlackboardArtifactTag object representing the new tag.

Exceptions

TskCoreException If there is an error adding the tag to the case database.

Definition at line 461 of file TagsManager.java.

Referenced by org.sleuthkit.autopsy.actions.AddBlackboardArtifactTagAction.addTag(), and org.sleuthkit.autopsy.actions.ReplaceBlackboardArtifactTagAction.replaceTag().

BlackboardArtifactTag org.sleuthkit.autopsy.casemodule.services.TagsManager.addBlackboardArtifactTag	(	BlackboardArtifact	artifact,
		TagName	tagName,
		String	comment
	)		throws TskCoreException

Tags an artifact.

Parameters

artifact	The artifact to tag.
tagName	The representation of the desired tag type in the case database, which can be obtained by calling getTagNames and/or addTagName.
comment	A comment to store with the tag.

Returns: A BlackboardArtifactTag object representing the new tag.

Exceptions

TskCoreException If there is an error adding the tag to the case database.

Definition at line 479 of file TagsManager.java.

References org.sleuthkit.autopsy.casemodule.Case.getCurrentCaseThrows(), and org.sleuthkit.autopsy.casemodule.Case.notifyBlackBoardArtifactTagAdded().

ContentTag org.sleuthkit.autopsy.casemodule.services.TagsManager.addContentTag	(	Content	content,
		TagName	tagName
	)		throws TskCoreException

Tags a content object.

Parameters

content	The content to tag.
tagName	The representation of the desired tag type in the case database, which can be obtained by calling getTagNames and/or addTagName.

Returns: A ContentTag object representing the new tag.

Exceptions

TskCoreException If there is an error adding the tag to the case database.

Definition at line 310 of file TagsManager.java.

Referenced by org.sleuthkit.autopsy.casemodule.services.TagsManager.addContentTag(), org.sleuthkit.autopsy.actions.AddContentTagAction.addTag(), and org.sleuthkit.autopsy.actions.ReplaceContentTagAction.replaceTag().

ContentTag org.sleuthkit.autopsy.casemodule.services.TagsManager.addContentTag	(	Content	content,
		TagName	tagName,
		String	comment
	)		throws TskCoreException

Tags a content object.

Parameters

content	The content to tag.
tagName	The representation of the desired tag type in the case database, which can be obtained by calling getTagNames and/or addTagName.
comment	A comment to store with the tag.

Returns: A ContentTag object representing the new tag.

Exceptions

TskCoreException If there is an error adding the tag to the case database.

Definition at line 328 of file TagsManager.java.

References org.sleuthkit.autopsy.casemodule.services.TagsManager.addContentTag().

ContentTag org.sleuthkit.autopsy.casemodule.services.TagsManager.addContentTag	(	Content	content,
		TagName	tagName,
		String	comment,
		long	beginByteOffset,
		long	endByteOffset
	)		throws TskCoreException

Tags a content object or a section of a content object.

Parameters

content	The content to tag.
tagName	The representation of the desired tag type in the case database, which can be obtained by calling getTagNames and/or addTagName.
comment	A comment to store with the tag.
beginByteOffset	Designates the beginning of a tagged section.
endByteOffset	Designates the end of a tagged section.

Returns: A ContentTag object representing the new tag.

Exceptions

TskCoreException If there is an error adding the tag to the case database.

Definition at line 348 of file TagsManager.java.

References org.sleuthkit.autopsy.casemodule.Case.getCurrentCaseThrows(), and org.sleuthkit.autopsy.casemodule.Case.notifyContentTagAdded().

synchronized TagName org.sleuthkit.autopsy.casemodule.services.TagsManager.addTagName ( String displayName ) throws TagNameAlreadyExistsException, TskCoreException

Adds a tag name entry to the case database and adds a corresponding tag type to the current user's custom tag types.

Parameters

displayName The display name for the new tag type.

Returns: A TagName representing the tag name database entry that can be used to add instances of the tag type to the case database.

Exceptions

TagNameAlreadyExistsException	If the tag name already exists in the case database.
TskCoreException	If there is an error adding the tag name to the case database.

Definition at line 220 of file TagsManager.java.

Referenced by org.sleuthkit.autopsy.casemodule.services.TagsManager.addTagName(), org.sleuthkit.autopsy.actions.AddTagAction.TagMenu.getAndAddTag(), and org.sleuthkit.autopsy.actions.GetTagNameDialog.okButtonActionPerformed().

synchronized TagName org.sleuthkit.autopsy.casemodule.services.TagsManager.addTagName	(	String	displayName,
		String	description
	)		throws TagNameAlreadyExistsException, TskCoreException

Adds a tag name entry to the case database and adds a corresponding tag type to the current user's custom tag types.

Parameters

displayName	The display name for the new tag type.
description	The description for the new tag type.

Returns: A TagName object that can be used to add instances of the tag type to the case database.

Exceptions

TagNameAlreadyExistsException	If the tag name already exists in the case database.
TskCoreException	If there is an error adding the tag name to the case database.

Definition at line 239 of file TagsManager.java.

References org.sleuthkit.autopsy.casemodule.services.TagsManager.addTagName().

synchronized TagName org.sleuthkit.autopsy.casemodule.services.TagsManager.addTagName	(	String	displayName,
		String	description,
		TagName.HTML_COLOR	color
	)		throws TagNameAlreadyExistsException, TskCoreException

Adds a tag name entry to the case database and adds a corresponding tag type to the current user's custom tag types.

Parameters

displayName	The display name for the new tag type.
description	The description for the new tag type.
color	The color to associate with the new tag type.

Returns: A TagName object that can be used to add instances of the tag type to the case database.

Exceptions

TagNameAlreadyExistsException	If the tag name already exists.
TskCoreException	If there is an error adding the tag name to the case database.

Definition at line 258 of file TagsManager.java.

References org.sleuthkit.autopsy.casemodule.services.TagsManager.addTagName().

synchronized TagName org.sleuthkit.autopsy.casemodule.services.TagsManager.addTagName	(	String	displayName,
		String	description,
		TagName.HTML_COLOR	color,
		TskData.FileKnown	knownStatus
	)		throws TagNameAlreadyExistsException, TskCoreException

Adds a tag name entry to the case database and adds a corresponding tag type to the current user's custom tag types.

Parameters

displayName	The display name for the new tag type.
description	The description for the new tag type.
color	The color to associate with the new tag type.
knownStatus	The knownStatus to be used for the tag when correlating on the tagged item

Returns: A TagName object that can be used to add instances of the tag type to the case database.

Exceptions

TagNameAlreadyExistsException	If the tag name already exists.
TskCoreException	If there is an error adding the tag name to the case database.

Definition at line 279 of file TagsManager.java.

void org.sleuthkit.autopsy.casemodule.services.TagsManager.close ( ) throws IOException

Closes the tags manager.

Exceptions

IOException If there is a problem closing the tags manager.

Deprecated:: Tags manager clients should not close the tags manager.

Definition at line 617 of file TagsManager.java.

static boolean org.sleuthkit.autopsy.casemodule.services.TagsManager.containsIllegalCharacters ( String tagDisplayName )

static

Tests whether or not a given tag display name contains an illegal character.

Parameters

tagDisplayName Display name of a tag.

Returns: True or false.

Definition at line 61 of file TagsManager.java.

Referenced by org.sleuthkit.autopsy.actions.GetTagNameDialog.okButtonActionPerformed().

void org.sleuthkit.autopsy.casemodule.services.TagsManager.deleteBlackboardArtifactTag ( BlackboardArtifactTag tag ) throws TskCoreException

Deletes an artifact tag.

Parameters

tag	The tag to delete.

Exceptions

TskCoreException If there is an error deleting the tag from the case database.

Definition at line 497 of file TagsManager.java.

References org.sleuthkit.autopsy.casemodule.Case.getCurrentCaseThrows(), and org.sleuthkit.autopsy.casemodule.Case.notifyBlackBoardArtifactTagDeleted().

Referenced by org.sleuthkit.autopsy.actions.DeleteBlackboardArtifactTagAction.actionPerformed(), org.sleuthkit.autopsy.actions.DeleteFileBlackboardArtifactTagAction.deleteTag(), and org.sleuthkit.autopsy.actions.ReplaceBlackboardArtifactTagAction.replaceTag().

void org.sleuthkit.autopsy.casemodule.services.TagsManager.deleteContentTag ( ContentTag tag ) throws TskCoreException

Deletes a content tag.

Parameters

tag	The tag to delete.

Exceptions

TskCoreException If there is an error deleting the tag from the case database.

Definition at line 367 of file TagsManager.java.

References org.sleuthkit.autopsy.casemodule.Case.getCurrentCaseThrows(), and org.sleuthkit.autopsy.casemodule.Case.notifyContentTagDeleted().

Referenced by org.sleuthkit.autopsy.actions.DeleteContentTagAction.actionPerformed(), org.sleuthkit.autopsy.actions.DeleteFileContentTagAction.deleteTag(), and org.sleuthkit.autopsy.actions.ReplaceContentTagAction.replaceTag().

List<BlackboardArtifactTag> org.sleuthkit.autopsy.casemodule.services.TagsManager.getAllBlackboardArtifactTags ( ) throws TskCoreException

Gets all artifact tags for the current case.

Returns: A list, possibly empty, of artifact tags.

Exceptions

TskCoreException If there is an error getting the tags from the case database.

Definition at line 514 of file TagsManager.java.

Referenced by org.sleuthkit.autopsy.timeline.db.EventsRepository.DBPopulationWorker.call().

List<ContentTag> org.sleuthkit.autopsy.casemodule.services.TagsManager.getAllContentTags ( ) throws TskCoreException

Gets all content tags for the current case.

Returns: A list, possibly empty, of content tags.

Exceptions

TskCoreException If there is an error getting the tags from the case database.

Definition at line 384 of file TagsManager.java.

Referenced by org.sleuthkit.autopsy.timeline.db.EventsRepository.DBPopulationWorker.call().

List<TagName> org.sleuthkit.autopsy.casemodule.services.TagsManager.getAllTagNames ( ) throws TskCoreException

Gets a list of all tag names currently in the case database.

Returns: A list, possibly empty, of TagName objects.

Exceptions

TskCoreException If there is an error querying the case database.

Definition at line 153 of file TagsManager.java.

Referenced by org.sleuthkit.autopsy.casemodule.services.TagsManager.getTagDisplayNames().

BlackboardArtifactTag org.sleuthkit.autopsy.casemodule.services.TagsManager.getBlackboardArtifactTagByTagID ( long tagId ) throws TskCoreException

Gets an artifact tag by tag id.

Parameters

tagId The tag id of interest.

Returns: The artifact tag with the specified tag id.

Exceptions

TskCoreException If there is an error getting the tag from the case database.

Definition at line 544 of file TagsManager.java.

List<BlackboardArtifactTag> org.sleuthkit.autopsy.casemodule.services.TagsManager.getBlackboardArtifactTagsByArtifact ( BlackboardArtifact artifact ) throws TskCoreException

Gets artifact tags for a particular artifact.

Parameters

artifact The artifact of interest.

Returns: A list, possibly empty, of the tags that have been applied to the artifact.

Exceptions

TskCoreException If there is an error getting the tags from the case database.

Definition at line 576 of file TagsManager.java.

Referenced by org.sleuthkit.autopsy.datamodel.BlackboardArtifactNode.addTagProperty(), org.sleuthkit.autopsy.timeline.datamodel.FilteredEventsModel.handleArtifactTagDeleted(), org.sleuthkit.autopsy.timeline.db.EventsRepository.DBPopulationWorker.insertEventForArtifact(), org.sleuthkit.autopsy.centralrepository.eventlisteners.CaseEventListener.BlackboardTagTask.run(), org.sleuthkit.autopsy.centralrepository.eventlisteners.CaseEventListener.TagDefinitionChangeTask.run(), and org.sleuthkit.autopsy.timeline.ui.listvew.ListTimeline.TaggedCell.updateItem().

List<BlackboardArtifactTag> org.sleuthkit.autopsy.casemodule.services.TagsManager.getBlackboardArtifactTagsByTagName ( TagName tagName ) throws TskCoreException

Gets artifact tags by tag name.

Parameters

tagName The representation of the desired tag type in the case database, which can be obtained by calling getTagNames and/or addTagName.

Returns: A list, possibly empty, of the artifact tags with the specified tag name.

Exceptions

TskCoreException If there is an error getting the tags from the case database.

Definition at line 561 of file TagsManager.java.

Referenced by org.sleuthkit.autopsy.datamodel.Tags.BlackboardArtifactTagNodeFactory.createKeys().

long org.sleuthkit.autopsy.casemodule.services.TagsManager.getBlackboardArtifactTagsCountByTagName ( TagName tagName ) throws TskCoreException

Gets an artifact tags count by tag name.

Parameters

tagName The representation of the desired tag type in the case database, which can be obtained by calling getTagNames and/or addTagName.

Returns: A count of the artifact tags with the specified tag name.

Exceptions

TskCoreException If there is an error getting the tags count from the case database.

Definition at line 530 of file TagsManager.java.

Referenced by org.sleuthkit.autopsy.datamodel.Tags.TagNameNode.updateDisplayName(), and org.sleuthkit.autopsy.datamodel.Tags.BlackboardArtifactTagTypeNode.updateDisplayName().

ContentTag org.sleuthkit.autopsy.casemodule.services.TagsManager.getContentTagByTagID ( long tagId ) throws TskCoreException

Gets a content tag by tag id.

Parameters

tagId The tag id of interest.

Returns: The content tag with the specified tag id.

Exceptions

TskCoreException If there is an error getting the tag from the case database.

Definition at line 414 of file TagsManager.java.

List<ContentTag> org.sleuthkit.autopsy.casemodule.services.TagsManager.getContentTagsByContent ( Content content ) throws TskCoreException

Gets content tags count by content.

Parameters

content The content of interest.

Returns: A list, possibly empty, of the tags that have been applied to the content.

Exceptions

TskCoreException If there is an error getting the tags from the case database.

Definition at line 444 of file TagsManager.java.

List<ContentTag> org.sleuthkit.autopsy.casemodule.services.TagsManager.getContentTagsByTagName ( TagName tagName ) throws TskCoreException

Gets content tags by tag name.

Parameters

tagName The tag name of interest.

Returns: A list, possibly empty, of the content tags with the specified tag name.

Exceptions

TskCoreException If there is an error getting the tags from the case database.

Definition at line 429 of file TagsManager.java.

Referenced by org.sleuthkit.autopsy.datamodel.Tags.ContentTagNodeFactory.createKeys(), and org.sleuthkit.autopsy.report.taggedhashes.AddTaggedHashesToHashDb.generateReport().

long org.sleuthkit.autopsy.casemodule.services.TagsManager.getContentTagsCountByTagName ( TagName tagName ) throws TskCoreException

Gets content tags count by tag name.

Parameters

tagName The representation of the desired tag type in the case database, which can be obtained by calling getTagNames and/or addTagName.

Returns: A count of the content tags with the specified tag name.

Exceptions

TskCoreException If there is an error getting the tags count from the case database.

Definition at line 400 of file TagsManager.java.

Referenced by org.sleuthkit.autopsy.datamodel.Tags.TagNameNode.updateDisplayName(), and org.sleuthkit.autopsy.datamodel.Tags.ContentTagTypeNode.updateDisplayName().

Map<String, TagName> org.sleuthkit.autopsy.casemodule.services.TagsManager.getDisplayNamesToTagNamesMap ( ) throws TskCoreException

Gets a map of tag display names to tag name entries in the case database. It has keys for the display names of the standard tag types, the current user's custom tag types, and the tags in the case database. The value for a given key will be null if the corresponding tag type is defined, but a tag name entry has not yet added to the case database. In that case, addTagName may be called to add the tag name entry.

Returns: A map of tag display names to possibly null TagName object references.

Exceptions

TskCoreException if there is an error querying the case database.

Order is important here. The keys (display names) for the current user's custom tag types are added to the map first, with null TagName values. If tag name entries exist for those keys, loading of the tag names from the database supplies the missing values. Standard tag names are added during the initialization of the case database.

Note that creating the map on demand increases the probability that the display names of newly added custom tag types and the display names of tags added to a multi-user case by other users appear in the map.

Definition at line 182 of file TagsManager.java.

Referenced by org.sleuthkit.autopsy.actions.AddBookmarkTagAction.actionPerformed(), org.sleuthkit.autopsy.actions.GetTagNameDialog.display(), org.sleuthkit.autopsy.actions.GetTagNameAndCommentDialog.display(), org.sleuthkit.autopsy.actions.AddTagAction.TagMenu.getAndAddTag(), org.sleuthkit.autopsy.actions.GetTagNameDialog.okButtonActionPerformed(), org.sleuthkit.autopsy.centralrepository.eventlisteners.CaseEventListener.TagDefinitionChangeTask.run(), and org.sleuthkit.autopsy.casemodule.services.TagsManager.tagNameExists().

static List<String> org.sleuthkit.autopsy.casemodule.services.TagsManager.getNotableTagDisplayNames ( )

static

Definition at line 114 of file TagsManager.java.

Referenced by org.sleuthkit.autopsy.centralrepository.eventlisteners.CaseEventListener.ContentTagTask.run(), and org.sleuthkit.autopsy.centralrepository.eventlisteners.CaseEventListener.BlackboardTagTask.run().

static String org.sleuthkit.autopsy.casemodule.services.TagsManager.getNotableTagLabel ( )

static

Get String of text which is used to label tags as notable to the user.

Returns: Bundle message TagsManager.notableTagEnding.text

Definition at line 80 of file TagsManager.java.

Referenced by org.sleuthkit.autopsy.actions.GetTagNameAndCommentDialog.display(), and org.sleuthkit.autopsy.report.TableReportGenerator.ArtifactData.getOrderedRowDataAsStrings().

static List<String> org.sleuthkit.autopsy.casemodule.services.TagsManager.getStandardTagNames ( )

static

Returns a list of names of standard/predefined tags

Returns: list of predefined tag names

Definition at line 129 of file TagsManager.java.

Referenced by org.sleuthkit.autopsy.actions.GetTagNameAndCommentDialog.display().

static Set<String> org.sleuthkit.autopsy.casemodule.services.TagsManager.getTagDisplayNames ( ) throws TskCoreException

static

Gets the set of display names of the currently available tag types. This includes the display names of the standard tag types, the current user's custom tag types, and the tags in the case database of the current case (if there is a current case).

Returns: A set, possibly empty, of tag type display names.

Exceptions

TskCoreException If there is a current case and there is an error querying the case database for tag types.

Definition at line 95 of file TagsManager.java.

References org.sleuthkit.autopsy.casemodule.services.TagsManager.getAllTagNames(), org.sleuthkit.autopsy.casemodule.Case.getCurrentCaseThrows(), org.sleuthkit.autopsy.casemodule.Case.getServices(), and org.sleuthkit.autopsy.casemodule.services.Services.getTagsManager().

List<TagName> org.sleuthkit.autopsy.casemodule.services.TagsManager.getTagNamesInUse ( ) throws TskCoreException

Gets a list of all tag names currently in use in the case database for tagging content or artifacts.

Returns: A list, possibly empty, of TagName objects.

Exceptions

TskCoreException If there is an error querying the case database.

Definition at line 165 of file TagsManager.java.

Referenced by org.sleuthkit.autopsy.datamodel.Tags.TagNameNodeFactory.createKeys().

boolean org.sleuthkit.autopsy.casemodule.services.TagsManager.tagNameExists ( String tagDisplayName )

Checks whether a tag name with a given display name exists in the case database.

Parameters

tagDisplayName The display name.

Returns: True or false.

Deprecated:: Not reliable for multi-user cases.

Definition at line 599 of file TagsManager.java.

References org.sleuthkit.autopsy.casemodule.services.TagsManager.getDisplayNamesToTagNamesMap().

Member Data Documentation

final SleuthkitCase org.sleuthkit.autopsy.casemodule.services.TagsManager.caseDb

private

Definition at line 51 of file TagsManager.java.

final Logger org.sleuthkit.autopsy.casemodule.services.TagsManager.LOGGER = Logger.getLogger(TagsManager.class.getName())

staticprivate

Definition at line 49 of file TagsManager.java.

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

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

Classes

Public Member Functions

Static Public Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Function Documentation

Member Data Documentation