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

TagName	addTagName (String displayName) throws TagNameAlreadyExistsException, TskCoreException

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

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

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

TagSet	addTagSet (String name, List< TagName > tagNameList) throws 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

synchronized List< TagName >	getAllTagNames ()

List< TagSet >	getAllTagSets () throws TskCoreException

BlackboardArtifactTag	getBlackboardArtifactTagByTagID (long tagId) throws TskCoreException

List< BlackboardArtifactTag >	getBlackboardArtifactTagsByArtifact (BlackboardArtifact artifact) throws TskCoreException

List< BlackboardArtifactTag >	getBlackboardArtifactTagsByTagName (TagName tagName) throws TskCoreException

List< BlackboardArtifactTag >	getBlackboardArtifactTagsByTagName (TagName tagName, long dsObjId) throws TskCoreException

long	getBlackboardArtifactTagsCountByTagName (TagName tagName) throws TskCoreException

long	getBlackboardArtifactTagsCountByTagName (TagName tagName, long dsObjId) throws TskCoreException

long	getBlackboardArtifactTagsCountByTagNameForUser (TagName tagName, String userName) throws TskCoreException

long	getBlackboardArtifactTagsCountByTagNameForUser (TagName tagName, long dsObjId, String userName) throws TskCoreException

ContentTag	getContentTagByTagID (long tagId) throws TskCoreException

List< ContentTag >	getContentTagsByContent (Content content) throws TskCoreException

List< ContentTag >	getContentTagsByTagName (TagName tagName) throws TskCoreException

List< ContentTag >	getContentTagsByTagName (TagName tagName, long dsObjId) throws TskCoreException

long	getContentTagsCountByTagName (TagName tagName) throws TskCoreException

long	getContentTagsCountByTagName (TagName tagName, long dsObjId) throws TskCoreException

long	getContentTagsCountByTagNameForUser (TagName tagName, String userName) throws TskCoreException

long	getContentTagsCountByTagNameForUser (TagName tagName, long dsObjId, String userName) throws TskCoreException

Map< String, TagName >	getDisplayNamesToTagNamesMap () throws TskCoreException

List< TagName >	getTagNamesInUse () throws TskCoreException

List< TagName >	getTagNamesInUse (long dsObjId) throws TskCoreException

List< TagName >	getTagNamesInUseForUser (String userName) throws TskCoreException

List< TagName >	getTagNamesInUseForUser (long dsObjId, String userName) throws TskCoreException

TagSet	getTagSet (TagName tagName) throws TskCoreException

boolean	tagNameExists (String tagDisplayName)

Static Public Member Functions
static void	addTagSetDefinition (TagSetDefinition tagSetDef) throws IOException

static boolean	containsIllegalCharacters (String tagDisplayName)

static String	getBookmarkTagDisplayName ()

static String	getFollowUpTagDisplayName ()

static String	getNotableTagDisplayName ()

static List< String >	getNotableTagDisplayNames ()

static String	getNotableTagLabel ()

static List< String >	getStandardTagNames ()

static Set< String >	getTagDisplayNames () throws TskCoreException

Private Attributes
final Map< String, TagName >	allTagNameMap = Collections.synchronizedMap(new HashMap<>())

final SleuthkitCase	caseDb

final PropertyChangeListener	listener

final PropertyChangeListener	weakListener = WeakListeners.propertyChange(listener, null)

Static Private Attributes
static final Object	lock = new Object()

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

static String	PROJECT_VIC_TAG_SET_NAME = "Project VIC"

Detailed Description

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

Definition at line 59 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 840 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 858 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 599 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 617 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 637 of file TagsManager.java.

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

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 507 of file TagsManager.java.

Referenced by org.sleuthkit.autopsy.casemodule.services.TagsManager.addTagName(), and org.sleuthkit.autopsy.actions.GetTagNameDialog.AddTagNameWorker.doInBackground().

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 526 of file TagsManager.java.

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

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 545 of file TagsManager.java.

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

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 566 of file TagsManager.java.

References org.sleuthkit.autopsy.casemodule.services.TagsManager.getAllTagNames(), and org.sleuthkit.autopsy.casemodule.services.TagsManager.lock.

TagSet org.sleuthkit.autopsy.casemodule.services.TagsManager.addTagSet	(	String	name,
		List< TagName >	tagNameList
	)		throws TskCoreException

Add a new TagSet to the case database. Tags will be ranked in the order which they are passed to this method.

Parameters

name	Tag set name.
tagNameList	List of TagName in rank order.

Returns: A new TagSet object.

Exceptions

TskCoreException

Definition at line 376 of file TagsManager.java.

static void org.sleuthkit.autopsy.casemodule.services.TagsManager.addTagSetDefinition ( TagSetDefinition tagSetDef ) throws IOException

static

Creates a new TagSetDefinition file that will be used for future cases

Parameters

tagSetDef The tag set definition.

Exceptions

IOException

Definition at line 283 of file TagsManager.java.

References org.sleuthkit.autopsy.casemodule.services.TagsManager.lock.

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 1085 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 136 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 877 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 658 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 894 of file TagsManager.java.

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 675 of file TagsManager.java.

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

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

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

Definition at line 385 of file TagsManager.java.

Referenced by org.sleuthkit.autopsy.casemodule.services.TagsManager.addTagName(), org.sleuthkit.autopsy.casemodule.services.TagsManager.getDisplayNamesToTagNamesMap(), org.sleuthkit.autopsy.casemodule.services.TagsManager.getNotableTagDisplayNames(), and org.sleuthkit.autopsy.casemodule.services.TagsManager.getTagDisplayNames().

List<TagSet> org.sleuthkit.autopsy.casemodule.services.TagsManager.getAllTagSets ( ) throws TskCoreException

Get a list of all tag sets currently in the case database.

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

Exceptions

TskCoreException

Definition at line 348 of file TagsManager.java.

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 994 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 1044 of file TagsManager.java.

Referenced by org.sleuthkit.autopsy.datamodel.BlackboardArtifactNode.addTagProperty(), org.sleuthkit.autopsy.datamodel.BlackboardArtifactNode.getAllTagsFromDatabase(), org.sleuthkit.autopsy.centralrepository.eventlisteners.CaseEventListener.BlackboardTagTask.handleTagChange(), and org.sleuthkit.autopsy.centralrepository.eventlisteners.CaseEventListener.TagDefinitionChangeTask.run().

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 1011 of file TagsManager.java.

Referenced by org.sleuthkit.autopsy.report.modules.portablecase.PortableCaseReportModule.addArtifactsToPortableCase(), org.sleuthkit.autopsy.datamodel.Tags.BlackboardArtifactTagNodeFactory.createKeys(), org.sleuthkit.autopsy.report.modules.portablecase.PortableCaseReportModule.generateCaseUcoReport(), and org.sleuthkit.autopsy.casemodule.services.TagsManager.getBlackboardArtifactTagsCountByTagNameForUser().

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

Gets artifact tags by tag name, for specified data source.

Parameters

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

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

Exceptions

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

Definition at line 1029 of file TagsManager.java.

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 910 of file TagsManager.java.

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

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

Gets an artifact tags count by tag name, for the given data source.

Parameters

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

Returns: A count of the artifact tags with the specified tag name, for the given data source.

Exceptions

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

Definition at line 953 of file TagsManager.java.

long org.sleuthkit.autopsy.casemodule.services.TagsManager.getBlackboardArtifactTagsCountByTagNameForUser	(	TagName	tagName,
		String	userName
	)		throws TskCoreException

Gets an artifact tags count by tag name for a specific user.

Parameters

tagName	The representation of the desired tag type in the case database, which can be obtained by calling getTagNames and/or addTagName.
userName	- the user name that you want to get tags for

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

Exceptions

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

Definition at line 928 of file TagsManager.java.

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

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

long org.sleuthkit.autopsy.casemodule.services.TagsManager.getBlackboardArtifactTagsCountByTagNameForUser	(	TagName	tagName,
		long	dsObjId,
		String	userName
	)		throws TskCoreException

Gets an artifact tags count by tag name, for the given data source and user.

Parameters

tagName	The representation of the desired tag type in the case database, which can be obtained by calling getTagNames and/or addTagName.
dsObjId	data source object id
userName	- the user name that you want to get tags for

Returns: A count of the artifact tags with the specified tag name, for the given data source and user.

Exceptions

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

Definition at line 973 of file TagsManager.java.

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

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

static

Returns the bookmark tag display string.

Returns

Definition at line 254 of file TagsManager.java.

Referenced by org.sleuthkit.autopsy.actions.AddBookmarkTagAction.actionPerformed(), org.sleuthkit.autopsy.actions.AddTagAction.TagMenu.createMenutItem(), and org.sleuthkit.autopsy.datamodel.Tags.TagNameNode.TagNameNode().

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 776 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 823 of file TagsManager.java.

Referenced by org.sleuthkit.autopsy.datamodel.BlackboardArtifactNode.addTagProperty(), org.sleuthkit.autopsy.report.modules.html.HTMLReport.addThumbnailRows(), org.sleuthkit.autopsy.datamodel.BlackboardArtifactNode.getAllTagsFromDatabase(), org.sleuthkit.autopsy.report.infrastructure.TableReportGenerator.ArtifactData.getOrderedRowDataAsStrings(), org.sleuthkit.autopsy.centralrepository.eventlisteners.CaseEventListener.ContentTagTask.handleTagChange(), and org.sleuthkit.autopsy.centralrepository.eventlisteners.CaseEventListener.TagDefinitionChangeTask.run().

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 791 of file TagsManager.java.

Referenced by org.sleuthkit.autopsy.report.modules.portablecase.PortableCaseReportModule.addFilesToPortableCase(), org.sleuthkit.autopsy.datamodel.Tags.ContentTagNodeFactory.createKeys(), org.sleuthkit.autopsy.report.modules.portablecase.PortableCaseReportModule.generateCaseUcoReport(), org.sleuthkit.autopsy.report.modules.taggedhashes.SaveTaggedHashesToHashDb.generateReport(), and org.sleuthkit.autopsy.casemodule.services.TagsManager.getContentTagsCountByTagNameForUser().

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

Gets content tags by tag name, for the given data source.

Parameters

tagName	The tag name of interest.
dsObjId	data source object id

Returns: A list, possibly empty, of the content tags with the specified tag name, and for the given data source.

Exceptions

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

Definition at line 808 of file TagsManager.java.

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 691 of file TagsManager.java.

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

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

Gets content tags count by tag name, for the given data source

Parameters

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

Returns: A count of the content tags with the specified tag name, and for the given data source

Exceptions

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

Definition at line 735 of file TagsManager.java.

long org.sleuthkit.autopsy.casemodule.services.TagsManager.getContentTagsCountByTagNameForUser	(	TagName	tagName,
		String	userName
	)		throws TskCoreException

Gets content tags count by tag name for the specified user.

Parameters

tagName	The representation of the desired tag type in the case database, which can be obtained by calling getTagNames and/or addTagName.
userName	- the user name that you want to get tags for

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

Exceptions

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

Definition at line 709 of file TagsManager.java.

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

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

long org.sleuthkit.autopsy.casemodule.services.TagsManager.getContentTagsCountByTagNameForUser	(	TagName	tagName,
		long	dsObjId,
		String	userName
	)		throws TskCoreException

Gets content tags count by tag name, for the given data source and user

Parameters

tagName	The representation of the desired tag type in the case database, which can be obtained by calling getTagNames and/or addTagName.
dsObjId	data source object id
userName	- the user name that you want to get tags for

Returns: A count of the content tags with the specified tag name, and for the given data source and user

Exceptions

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

Definition at line 755 of file TagsManager.java.

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

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.

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

Exceptions

TskCoreException if there is an error querying the case database.

Definition at line 485 of file TagsManager.java.

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

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

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

static

Returns the Follow Up tag display string.

Returns

Definition at line 263 of file TagsManager.java.

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

static

Returns the Notable tag display string.

Returns

Definition at line 272 of file TagsManager.java.

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

static

Gets the set of display names of notable (TskData.FileKnown.BAD) tag types. If a case is not open the list will only include only the user defined custom tags. Otherwise the list will include all notable tags.

Returns

Definition at line 197 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().

Referenced by org.sleuthkit.autopsy.centralrepository.eventlisteners.CaseEventListener.isNotableTagName().

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 156 of file TagsManager.java.

Referenced by org.sleuthkit.autopsy.report.modules.html.HTMLReport.addThumbnailRows(), org.sleuthkit.autopsy.actions.AddTagAction.TagMenu.createMenutItem(), and org.sleuthkit.autopsy.report.infrastructure.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 226 of file TagsManager.java.

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

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

Referenced by org.sleuthkit.autopsy.datamodel.Tags.TagNameNodeFactory.createKeys(), and org.sleuthkit.autopsy.report.modules.portablecase.PortableCaseReportModule.generateReport().

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

Selects all of the rows from the tag_names table in the case database for which there is at least one matching row in the content_tags or blackboard_artifact_tags tables, for the given data source object id.

Parameters

dsObjId data source object id

Returns: A list, possibly empty, of TagName data transfer objects (DTOs) for the rows.

Exceptions

TskCoreException

Definition at line 443 of file TagsManager.java.

List<TagName> org.sleuthkit.autopsy.casemodule.services.TagsManager.getTagNamesInUseForUser ( String userName ) throws TskCoreException

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

Parameters

userName - the user name that you want to get tags for

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

Exceptions

TskCoreException If there is an error querying the case database.

Definition at line 414 of file TagsManager.java.

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

List<TagName> org.sleuthkit.autopsy.casemodule.services.TagsManager.getTagNamesInUseForUser	(	long	dsObjId,
		String	userName
	)		throws TskCoreException

Selects all of the rows from the tag_names table in the case database for which there is at least one matching row in the content_tags or blackboard_artifact_tags tables, for the given data source object id and user.

Parameters

dsObjId	data source object id
userName	- the user name that you want to get tags for

Returns: A list, possibly empty, of TagName data transfer objects (DTOs) for the rows.

Exceptions

TskCoreException

Definition at line 461 of file TagsManager.java.

TagSet org.sleuthkit.autopsy.casemodule.services.TagsManager.getTagSet ( TagName tagName ) throws TskCoreException

Gets the tag set a tag name (tag definition) belongs to, if any.

Parameters

tagName The tag name.

Returns: A TagSet object or null.

Exceptions

TskCoreException If there is an error querying the case database.

Definition at line 361 of file TagsManager.java.

Referenced by org.sleuthkit.autopsy.actions.GetTagNameAndCommentDialog.display(), and org.sleuthkit.autopsy.tags.TagUtils.getDecoratedTagDisplayName().

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 1067 of file TagsManager.java.

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

Member Data Documentation

final Map<String, TagName> org.sleuthkit.autopsy.casemodule.services.TagsManager.allTagNameMap = Collections.synchronizedMap(new HashMap<>())

private

Definition at line 70 of file TagsManager.java.

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

private

Definition at line 62 of file TagsManager.java.

final PropertyChangeListener org.sleuthkit.autopsy.casemodule.services.TagsManager.listener

private

Initial value:

= new PropertyChangeListener() {
        @Override
        public void propertyChange(PropertyChangeEvent evt) {
            if (evt.getPropertyName().equals(Case.Events.TAG_NAMES_ADDED.name())
                    || evt.getPropertyName().equals(Case.Events.TAG_NAMES_UPDATED.name())) {
                TagNamesEvent tagEvent = (TagNamesEvent) evt;
                List<TagName> addTagNames = tagEvent.getTagNames();
                for (TagName tag : addTagNames) {
                    allTagNameMap.put(tag.getDisplayName(), tag);
                }
            } else if (evt.getPropertyName().equals(Case.Events.TAG_NAMES_DELETED.name())) {
                TagNamesDeletedEvent tagEvent = (TagNamesDeletedEvent) evt;
                List<Long> deletedIds = tagEvent.getTagNameIds();
                List<String> keysToRemove = new ArrayList<>();
                for (TagName tagName : getAllTagNames()) {
                    if (deletedIds.contains(tagName.getId())) {
                        keysToRemove.add(tagName.getDisplayName());
                    }
                }
                for (String key : keysToRemove) {
                    allTagNameMap.remove(key);
                }
            }
        }
    }

Definition at line 72 of file TagsManager.java.

final Object org.sleuthkit.autopsy.casemodule.services.TagsManager.lock = new Object()

staticprivate

Definition at line 68 of file TagsManager.java.

Referenced by org.sleuthkit.autopsy.casemodule.services.TagsManager.addTagName(), and org.sleuthkit.autopsy.casemodule.services.TagsManager.addTagSetDefinition().

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

staticprivate

Definition at line 61 of file TagsManager.java.

String org.sleuthkit.autopsy.casemodule.services.TagsManager.PROJECT_VIC_TAG_SET_NAME = "Project VIC"

staticprivate

Definition at line 66 of file TagsManager.java.

final PropertyChangeListener org.sleuthkit.autopsy.casemodule.services.TagsManager.weakListener = WeakListeners.propertyChange(listener, null)

private

Definition at line 99 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