Autopsy  4.5.0
Graphical digital forensics platform for The Sleuth Kit and other tools.
Classes | Public Member Functions | Static Public 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

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 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 46 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
artifactThe artifact to tag.
tagNameThe 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
TskCoreExceptionIf there is an error adding the tag to the case database.

Definition at line 451 of file TagsManager.java.

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

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

Tags an artifact.

Parameters
artifactThe artifact to tag.
tagNameThe representation of the desired tag type in the case database, which can be obtained by calling getTagNames and/or addTagName.
commentA comment to store with the tag.
Returns
A BlackboardArtifactTag object representing the new tag.
Exceptions
TskCoreExceptionIf there is an error adding the tag to the case database.

Definition at line 469 of file TagsManager.java.

References org.sleuthkit.autopsy.casemodule.Case.getCurrentCase(), 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
contentThe content to tag.
tagNameThe 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
TskCoreExceptionIf there is an error adding the tag to the case database.

Definition at line 300 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
contentThe content to tag.
tagNameThe representation of the desired tag type in the case database, which can be obtained by calling getTagNames and/or addTagName.
commentA comment to store with the tag.
Returns
A ContentTag object representing the new tag.
Exceptions
TskCoreExceptionIf there is an error adding the tag to the case database.

Definition at line 318 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
contentThe content to tag.
tagNameThe representation of the desired tag type in the case database, which can be obtained by calling getTagNames and/or addTagName.
commentA comment to store with the tag.
beginByteOffsetDesignates the beginning of a tagged section.
endByteOffsetDesignates the end of a tagged section.
Returns
A ContentTag object representing the new tag.
Exceptions
TskCoreExceptionIf there is an error adding the tag to the case database.

Definition at line 338 of file TagsManager.java.

References org.sleuthkit.autopsy.casemodule.Case.getCurrentCase(), 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
displayNameThe 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
TagNameAlreadyExistsExceptionIf the tag name already exists in the case database.
TskCoreExceptionIf there is an error adding the tag name to the case database.

Definition at line 210 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
displayNameThe display name for the new tag type.
descriptionThe 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
TagNameAlreadyExistsExceptionIf the tag name already exists in the case database.
TskCoreExceptionIf there is an error adding the tag name to the case database.

Definition at line 229 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
displayNameThe display name for the new tag type.
descriptionThe description for the new tag type.
colorThe 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
TagNameAlreadyExistsExceptionIf the tag name already exists.
TskCoreExceptionIf there is an error adding the tag name to the case database.

Definition at line 248 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
displayNameThe display name for the new tag type.
descriptionThe description for the new tag type.
colorThe color to associate with the new tag type.
knownStatusThe 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
TagNameAlreadyExistsExceptionIf the tag name already exists.
TskCoreExceptionIf there is an error adding the tag name to the case database.

Definition at line 269 of file TagsManager.java.

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

Closes the tags manager.

Exceptions
IOExceptionIf there is a problem closing the tags manager.
Deprecated:
Tags manager clients should not close the tags manager.

Definition at line 607 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
tagDisplayNameDisplay name of a tag.
Returns
True or false.

Definition at line 60 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
tagThe tag to delete.
Exceptions
TskCoreExceptionIf there is an error deleting the tag from the case database.

Definition at line 487 of file TagsManager.java.

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

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

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

Deletes a content tag.

Parameters
tagThe tag to delete.
Exceptions
TskCoreExceptionIf there is an error deleting the tag from the case database.

Definition at line 357 of file TagsManager.java.

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

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

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
TskCoreExceptionIf there is an error getting the tags from the case database.

Definition at line 504 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
TskCoreExceptionIf there is an error getting the tags from the case database.

Definition at line 374 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
TskCoreExceptionIf there is an error querying the case database.

Definition at line 143 of file TagsManager.java.

Referenced by org.sleuthkit.autopsy.actions.GetTagNameAndCommentDialog.display(), and 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
tagIdThe tag id of interest.
Returns
The artifact tag with the specified tag id.
Exceptions
TskCoreExceptionIf there is an error getting the tag from the case database.

Definition at line 534 of file TagsManager.java.

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

Gets artifact tags by tag name.

Parameters
tagNameThe 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
TskCoreExceptionIf there is an error getting the tags from the case database.

Definition at line 551 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
tagNameThe 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
TskCoreExceptionIf there is an error getting the tags count from the case database.

Definition at line 520 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
tagIdThe tag id of interest.
Returns
The content tag with the specified tag id.
Exceptions
TskCoreExceptionIf there is an error getting the tag from the case database.

Definition at line 404 of file TagsManager.java.

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

Gets content tags by tag name.

Parameters
tagNameThe tag name of interest.
Returns
A list, possibly empty, of the content tags with the specified tag name.
Exceptions
TskCoreExceptionIf there is an error getting the tags from the case database.

Definition at line 419 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
tagNameThe 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
TskCoreExceptionIf there is an error getting the tags count from the case database.

Definition at line 390 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
TskCoreExceptionif 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 172 of file TagsManager.java.

Referenced by org.sleuthkit.autopsy.actions.AddBookmarkTagAction.actionPerformed(), org.sleuthkit.autopsy.actions.GetTagNameDialog.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
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 79 of file TagsManager.java.

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

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
TskCoreExceptionIf there is a current case and there is an error querying the case database for tag types.

Definition at line 94 of file TagsManager.java.

References org.sleuthkit.autopsy.casemodule.services.TagsManager.getAllTagNames(), org.sleuthkit.autopsy.casemodule.Case.getCurrentCase(), 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
TskCoreExceptionIf there is an error querying the case database.

Definition at line 155 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
tagDisplayNameThe display name.
Returns
True or false.
Deprecated:
Not reliable for multi-user cases.

Definition at line 589 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 50 of file TagsManager.java.

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

Definition at line 48 of file TagsManager.java.


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

Copyright © 2012-2016 Basis Technology. Generated on: Tue Feb 20 2018
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.