Autopsy  3.1
Graphical digital forensics platform for The Sleuth Kit and other tools.
Classes | Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
org.sleuthkit.autopsy.casemodule.services.TagsManager Class Reference

Inherits Closeable.

Classes

class  TagNameAlreadyExistsException
 

Public Member Functions

synchronized List< TagNamegetAllTagNames () throws TskCoreException
 
synchronized List< TagNamegetTagNamesInUse () throws TskCoreException
 
synchronized boolean tagNameExists (String tagDisplayName)
 
TagName addTagName (String displayName) throws TagNameAlreadyExistsException, TskCoreException
 
TagName addTagName (String displayName, String description) throws TagNameAlreadyExistsException, TskCoreException
 
synchronized TagName addTagName (String displayName, String description, TagName.HTML_COLOR color) throws TagNameAlreadyExistsException, TskCoreException
 
ContentTag addContentTag (Content content, TagName tagName) throws TskCoreException
 
ContentTag addContentTag (Content content, TagName tagName, String comment) throws TskCoreException
 
synchronized ContentTag addContentTag (Content content, TagName tagName, String comment, long beginByteOffset, long endByteOffset) throws IllegalArgumentException, TskCoreException
 
synchronized void deleteContentTag (ContentTag tag) throws TskCoreException
 
List< ContentTaggetAllContentTags () throws TskCoreException
 
synchronized long getContentTagsCountByTagName (TagName tagName) throws TskCoreException
 
synchronized List< ContentTaggetContentTagsByTagName (TagName tagName) throws TskCoreException
 
synchronized List< ContentTaggetContentTagsByContent (Content content) throws TskCoreException
 
BlackboardArtifactTag addBlackboardArtifactTag (BlackboardArtifact artifact, TagName tagName) throws TskCoreException
 
synchronized BlackboardArtifactTag addBlackboardArtifactTag (BlackboardArtifact artifact, TagName tagName, String comment) throws TskCoreException
 
synchronized void deleteBlackboardArtifactTag (BlackboardArtifactTag tag) throws TskCoreException
 
List< BlackboardArtifactTaggetAllBlackboardArtifactTags () throws TskCoreException
 
synchronized long getBlackboardArtifactTagsCountByTagName (TagName tagName) throws TskCoreException
 
synchronized List< BlackboardArtifactTaggetBlackboardArtifactTagsByTagName (TagName tagName) throws TskCoreException
 
synchronized List< BlackboardArtifactTaggetBlackboardArtifactTagsByArtifact (BlackboardArtifact artifact) throws TskCoreException
 
void close () throws IOException
 

Private Member Functions

void getExistingTagNames ()
 
void getTagNamesFromCurrentCase ()
 
void getTagNamesFromTagsSettings ()
 
void getPredefinedTagNames ()
 
void saveTagNamesToTagsSettings ()
 

Private Attributes

final SleuthkitCase tskCase
 
final HashMap< String, TagNameuniqueTagNames = new HashMap<>()
 
boolean tagNamesInitialized = false
 

Static Private Attributes

static final String TAGS_SETTINGS_NAME = "Tags"
 
static final String TAG_NAMES_SETTING_KEY = "TagNames"
 

Detailed Description

A per case instance of this class functions as an Autopsy service that manages the creation, updating, and deletion of tags applied to content and blackboard artifacts by users.

Definition at line 44 of file TagsManager.java.

Member Function Documentation

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

Tags a blackboard artifact object.

Parameters
[in]artifactThe blackboard artifact to tag.
[in]tagNameThe name to use for the tag.
Returns
A BlackboardArtifactTag data transfer object (DTO) representing the new tag.
Exceptions
TskCoreException

Definition at line 303 of file TagsManager.java.

Referenced by org.sleuthkit.autopsy.actions.AddBlackboardArtifactTagAction.addTag().

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

Tags a blackboard artifact object.

Parameters
[in]artifactThe blackboard artifact to tag.
[in]tagNameThe name to use for the tag.
[in]commentA comment to store with the tag.
Returns
A BlackboardArtifactTag data transfer object (DTO) representing the new tag.
Exceptions
TskCoreException

Definition at line 315 of file TagsManager.java.

References org::sleuthkit::datamodel::SleuthkitCase.addBlackboardArtifactTag(), and org.sleuthkit.autopsy.casemodule.services.TagsManager.getExistingTagNames().

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

Tags a content object.

Parameters
[in]contentThe content to tag.
[in]tagNameThe name to use for the tag.
Returns
A ContentTag data transfer object (DTO) representing the new tag.
Exceptions
TskCoreException

Definition at line 169 of file TagsManager.java.

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

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

Tags a content object.

Parameters
[in]contentThe content to tag.
[in]tagNameThe name to use for the tag.
[in]commentA comment to store with the tag.
Returns
A ContentTag data transfer object (DTO) representing the new tag.
Exceptions
TskCoreException

Definition at line 181 of file TagsManager.java.

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

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

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

Parameters
[in]contentThe content to tag.
[in]tagNameThe name to use for the tag.
[in]commentA comment to store with the tag.
[in]beginByteOffsetDesignates the beginning of a tagged section.
[in]endByteOffsetDesignates the end of a tagged section.
Returns
A ContentTag data transfer object (DTO) representing the new tag.
Exceptions
IllegalArgumentException,TskCoreException

Definition at line 195 of file TagsManager.java.

References org::sleuthkit::datamodel::SleuthkitCase.addContentTag(), and org.sleuthkit.autopsy.casemodule.services.TagsManager.getExistingTagNames().

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

Adds a new tag name to the current case and to the tags settings.

Parameters
[in]displayNameThe display name for the new tag name.
Returns
A TagName data transfer object (DTO) representing the new tag name.
Exceptions
TagNameAlreadyExistsException,TskCoreException

Definition at line 119 of file TagsManager.java.

References org::sleuthkit::datamodel::TagName::HTML_COLOR.NONE.

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

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

Adds a new tag name to the current case and to the tags settings.

Parameters
[in]displayNameThe display name for the new tag name.
[in]descriptionThe description for the new tag name.
Returns
A TagName data transfer object (DTO) representing the new tag name.
Exceptions
TagNameAlreadyExistsException,TskCoreException

Definition at line 130 of file TagsManager.java.

References org.sleuthkit.autopsy.casemodule.services.TagsManager.addTagName(), and org::sleuthkit::datamodel::TagName::HTML_COLOR.NONE.

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

Adds a new tag name to the current case and to the tags settings.

Parameters
[in]displayNameThe display name for the new tag name.
[in]descriptionThe description for the new tag name.
[in]colorThe HTML color to associate with the new tag name.
Returns
A TagName data transfer object (DTO) representing the new tag name.
Exceptions
TagNameAlreadyExistsException,TskCoreException

Definition at line 142 of file TagsManager.java.

References org::sleuthkit::datamodel::SleuthkitCase.addTagName(), org::sleuthkit::datamodel::TagName.getDisplayName(), org.sleuthkit.autopsy.casemodule.services.TagsManager.getExistingTagNames(), and org.sleuthkit.autopsy.casemodule.services.TagsManager.saveTagNamesToTagsSettings().

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

Deletes a blackboard artifact tag.

Parameters
[in]tagThe tag to delete.
Exceptions
TskCoreException

Definition at line 329 of file TagsManager.java.

References org::sleuthkit::datamodel::SleuthkitCase.deleteBlackboardArtifactTag(), and org.sleuthkit.autopsy.casemodule.services.TagsManager.getExistingTagNames().

Referenced by org.sleuthkit.autopsy.actions.DeleteBlackboardArtifactTagAction.doAction().

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

Deletes a content tag.

Parameters
[in]tagThe tag to delete.
Exceptions
TskCoreException

Definition at line 228 of file TagsManager.java.

References org::sleuthkit::datamodel::SleuthkitCase.deleteContentTag(), and org.sleuthkit.autopsy.casemodule.services.TagsManager.getExistingTagNames().

Referenced by org.sleuthkit.autopsy.actions.DeleteContentTagAction.doAction().

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

Gets all blackboard artifact tags for the current case.

Returns
A list, possibly empty, of blackboard artifact tags.
Exceptions
TskCoreException

Definition at line 343 of file TagsManager.java.

References org::sleuthkit::datamodel::SleuthkitCase.getAllBlackboardArtifactTags(), and org.sleuthkit.autopsy.casemodule.services.TagsManager.getExistingTagNames().

Referenced by org.sleuthkit.autopsy.report.ReportGenerator.TableReportsWorker.makeBlackboardArtifactTagsTables().

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

Definition at line 242 of file TagsManager.java.

References org::sleuthkit::datamodel::SleuthkitCase.getAllContentTags(), and org.sleuthkit.autopsy.casemodule.services.TagsManager.getExistingTagNames().

Referenced by org.sleuthkit.autopsy.report.ReportGenerator.TableReportsWorker.makeContentTagsTables().

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

Gets a list of all tag names currently available for tagging content or blackboard artifacts.

Returns
A list, possibly empty, of TagName data transfer objects (DTOs).
Exceptions
TskCoreException

Definition at line 75 of file TagsManager.java.

References org::sleuthkit::datamodel::SleuthkitCase.getAllTagNames(), and org.sleuthkit.autopsy.casemodule.services.TagsManager.getExistingTagNames().

Referenced by org.sleuthkit.autopsy.actions.GetTagNameAndCommentDialog.GetTagNameAndCommentDialog(), and org.sleuthkit.autopsy.actions.GetTagNameDialog.GetTagNameDialog().

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

Gets blackboard artifact tags for a particular blackboard artifact.

Parameters
[in]artifactThe blackboard artifact of interest.
Returns
A list, possibly empty, of the tags that have been applied to the artifact.
Exceptions
TskCoreException

Definition at line 388 of file TagsManager.java.

References org::sleuthkit::datamodel::SleuthkitCase.getBlackboardArtifactTagsByArtifact(), and org.sleuthkit.autopsy.casemodule.services.TagsManager.getExistingTagNames().

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

Gets blackboard artifact tags by tag name.

Parameters
[in]tagNameThe tag name of interest.
Returns
A list, possibly empty, of the blackboard artifact tags with the specified tag name.
Exceptions
TskCoreException

Definition at line 373 of file TagsManager.java.

References org::sleuthkit::datamodel::SleuthkitCase.getBlackboardArtifactTagsByTagName(), and org.sleuthkit.autopsy.casemodule.services.TagsManager.getExistingTagNames().

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

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

Gets blackboard artifact tags count by tag name.

Parameters
[in]tagNameThe tag name of interest.
Returns
A count of the blackboard artifact tags with the specified tag name.
Exceptions
TskCoreException

Definition at line 358 of file TagsManager.java.

References org::sleuthkit::datamodel::SleuthkitCase.getBlackboardArtifactTagsCountByTagName(), and org.sleuthkit.autopsy.casemodule.services.TagsManager.getExistingTagNames().

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

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

Gets content tags count by content.

Parameters
[in]contentThe content of interest.
Returns
A list, possibly empty, of the tags that have been applied to the artifact.
Exceptions
TskCoreException

Definition at line 287 of file TagsManager.java.

References org::sleuthkit::datamodel::SleuthkitCase.getContentTagsByContent(), and org.sleuthkit.autopsy.casemodule.services.TagsManager.getExistingTagNames().

Referenced by org.sleuthkit.autopsy.actions.AddContentTagAction.addTag().

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

Gets content tags by tag name.

Parameters
[in]tagNameThe tag name of interest.
Returns
A list, possibly empty, of the content tags with the specified tag name.
Exceptions
TskCoreException

Definition at line 272 of file TagsManager.java.

References org::sleuthkit::datamodel::SleuthkitCase.getContentTagsByTagName(), and org.sleuthkit.autopsy.casemodule.services.TagsManager.getExistingTagNames().

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

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

Gets content tags count by tag name.

Parameters
[in]tagNameThe tag name of interest.
Returns
A count of the content tags with the specified tag name.
Exceptions
TskCoreException

Definition at line 257 of file TagsManager.java.

References org::sleuthkit::datamodel::SleuthkitCase.getContentTagsCountByTagName(), and org.sleuthkit.autopsy.casemodule.services.TagsManager.getExistingTagNames().

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

void org.sleuthkit.autopsy.casemodule.services.TagsManager.getExistingTagNames ( )
private

Definition at line 402 of file TagsManager.java.

References org.sleuthkit.autopsy.casemodule.services.TagsManager.getPredefinedTagNames(), org.sleuthkit.autopsy.casemodule.services.TagsManager.getTagNamesFromCurrentCase(), org.sleuthkit.autopsy.casemodule.services.TagsManager.getTagNamesFromTagsSettings(), and org.sleuthkit.autopsy.casemodule.services.TagsManager.saveTagNamesToTagsSettings().

Referenced by org.sleuthkit.autopsy.casemodule.services.TagsManager.addBlackboardArtifactTag(), org.sleuthkit.autopsy.casemodule.services.TagsManager.addContentTag(), org.sleuthkit.autopsy.casemodule.services.TagsManager.addTagName(), org.sleuthkit.autopsy.casemodule.services.TagsManager.deleteBlackboardArtifactTag(), org.sleuthkit.autopsy.casemodule.services.TagsManager.deleteContentTag(), org.sleuthkit.autopsy.casemodule.services.TagsManager.getAllBlackboardArtifactTags(), org.sleuthkit.autopsy.casemodule.services.TagsManager.getAllContentTags(), org.sleuthkit.autopsy.casemodule.services.TagsManager.getAllTagNames(), org.sleuthkit.autopsy.casemodule.services.TagsManager.getBlackboardArtifactTagsByArtifact(), org.sleuthkit.autopsy.casemodule.services.TagsManager.getBlackboardArtifactTagsByTagName(), org.sleuthkit.autopsy.casemodule.services.TagsManager.getBlackboardArtifactTagsCountByTagName(), org.sleuthkit.autopsy.casemodule.services.TagsManager.getContentTagsByContent(), org.sleuthkit.autopsy.casemodule.services.TagsManager.getContentTagsByTagName(), org.sleuthkit.autopsy.casemodule.services.TagsManager.getContentTagsCountByTagName(), org.sleuthkit.autopsy.casemodule.services.TagsManager.getTagNamesInUse(), and org.sleuthkit.autopsy.casemodule.services.TagsManager.tagNameExists().

void org.sleuthkit.autopsy.casemodule.services.TagsManager.getPredefinedTagNames ( )
private
void org.sleuthkit.autopsy.casemodule.services.TagsManager.getTagNamesFromCurrentCase ( )
private
void org.sleuthkit.autopsy.casemodule.services.TagsManager.getTagNamesFromTagsSettings ( )
private
synchronized List<TagName> org.sleuthkit.autopsy.casemodule.services.TagsManager.getTagNamesInUse ( ) throws TskCoreException

Gets a list of all tag names currently used for tagging content or blackboard artifacts.

Returns
A list, possibly empty, of TagName data transfer objects (DTOs).
Exceptions
TskCoreException

Definition at line 90 of file TagsManager.java.

References org.sleuthkit.autopsy.casemodule.services.TagsManager.getExistingTagNames(), and org::sleuthkit::datamodel::SleuthkitCase.getTagNamesInUse().

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

void org.sleuthkit.autopsy.casemodule.services.TagsManager.saveTagNamesToTagsSettings ( )
private
synchronized boolean org.sleuthkit.autopsy.casemodule.services.TagsManager.tagNameExists ( String  tagDisplayName)

Checks whether a tag name with a given display name exists.

Parameters
[in]tagDisplayNameThe display name for which to check.
Returns
True if the tag name exists, false otherwise.

Definition at line 104 of file TagsManager.java.

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

Member Data Documentation

final String org.sleuthkit.autopsy.casemodule.services.TagsManager.TAG_NAMES_SETTING_KEY = "TagNames"
staticprivate

Definition at line 46 of file TagsManager.java.

boolean org.sleuthkit.autopsy.casemodule.services.TagsManager.tagNamesInitialized = false
private

Definition at line 49 of file TagsManager.java.

final String org.sleuthkit.autopsy.casemodule.services.TagsManager.TAGS_SETTINGS_NAME = "Tags"
staticprivate

Definition at line 45 of file TagsManager.java.

final SleuthkitCase org.sleuthkit.autopsy.casemodule.services.TagsManager.tskCase
private

Definition at line 47 of file TagsManager.java.

final HashMap<String, TagName> org.sleuthkit.autopsy.casemodule.services.TagsManager.uniqueTagNames = new HashMap<>()
private

Definition at line 48 of file TagsManager.java.


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

Copyright © 2012-2015 Basis Technology. Generated on: Mon Oct 19 2015
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.