Sleuth Kit Java Bindings (JNI)
4.12.1
Java bindings for using The Sleuth Kit
|
Classes | |
class | BlackboardArtifactTagChange |
class | ContentTagChange |
Public Member Functions | |
BlackboardArtifactTagChange | addArtifactTag (BlackboardArtifact artifact, TagName tagName, String comment) throws TskCoreException |
ContentTagChange | addContentTag (Content content, TagName tagName, String comment, long beginByteOffset, long endByteOffset) throws TskCoreException |
TagName | addOrUpdateTagName (String displayName, String description, TagName.HTML_COLOR color, TskData.FileKnown knownStatus) throws TskCoreException |
TagSet | addTagSet (String name, List< TagName > tagNames) throws TskCoreException |
void | deleteTagSet (TagSet tagSet) throws TskCoreException |
TagName | getTagName (long id) throws TskCoreException |
TagSet | getTagSet (TagName tagName) throws TskCoreException |
TagSet | getTagSet (long id) throws TskCoreException |
List< TagSet > | getTagSets () throws TskCoreException |
Provides an API to manage Tags.
Definition at line 41 of file TaggingManager.java.
BlackboardArtifactTagChange org.sleuthkit.datamodel.TaggingManager.addArtifactTag | ( | BlackboardArtifact | artifact, |
TagName | tagName, | ||
String | comment | ||
) | throws TskCoreException |
Inserts a row into the blackboard_artifact_tags table in the case database.
artifact | The blackboard artifact to tag. |
tagName | The name to use for the tag. |
comment | A comment to store with the tag. |
TskCoreException |
Definition at line 264 of file TaggingManager.java.
References org.sleuthkit.datamodel.SleuthkitCase.beginTransaction(), org.sleuthkit.datamodel.TagName.HTML_COLOR.getColorByName(), org.sleuthkit.datamodel.SleuthkitCase.getContentById(), org.sleuthkit.datamodel.SleuthkitCase.getCurrentExaminer(), org.sleuthkit.datamodel.SleuthkitCase.getDatabaseType(), org.sleuthkit.datamodel.Examiner.getId(), org.sleuthkit.datamodel.Examiner.getLoginName(), org.sleuthkit.datamodel.SleuthkitCase.getScoringManager(), and org.sleuthkit.datamodel.TskData.FileKnown.valueOf().
Referenced by org.sleuthkit.datamodel.SleuthkitCase.addBlackboardArtifactTag().
ContentTagChange org.sleuthkit.datamodel.TaggingManager.addContentTag | ( | Content | content, |
TagName | tagName, | ||
String | comment, | ||
long | beginByteOffset, | ||
long | endByteOffset | ||
) | throws TskCoreException |
Inserts a row into the content_tags table in the case database.
content | The content to tag. |
tagName | The name to use for the tag. |
comment | A comment to store with the tag. |
beginByteOffset | Designates the beginning of a tagged section. |
endByteOffset | Designates the end of a tagged section. |
TskCoreException |
Definition at line 442 of file TaggingManager.java.
References org.sleuthkit.datamodel.SleuthkitCase.beginTransaction(), org.sleuthkit.datamodel.SleuthkitCase.CaseDbTransaction.commit(), org.sleuthkit.datamodel.TagName.HTML_COLOR.getColorByName(), org.sleuthkit.datamodel.SleuthkitCase.getCurrentExaminer(), org.sleuthkit.datamodel.SleuthkitCase.getDatabaseType(), org.sleuthkit.datamodel.Tag.getId(), org.sleuthkit.datamodel.SleuthkitCase.getScoringManager(), org.sleuthkit.datamodel.SleuthkitCase.CaseDbTransaction.rollback(), and org.sleuthkit.datamodel.TskData.FileKnown.valueOf().
Referenced by org.sleuthkit.datamodel.SleuthkitCase.addContentTag().
TagName org.sleuthkit.datamodel.TaggingManager.addOrUpdateTagName | ( | String | displayName, |
String | description, | ||
TagName.HTML_COLOR | color, | ||
TskData.FileKnown | knownStatus | ||
) | throws TskCoreException |
Inserts row into the tags_names table, or updates the existing row if the displayName already exists in the tag_names table in the case database.
displayName | The display name for the new tag name. |
description | The description for the new tag name. |
color | The HTML color to associate with the new tag name. |
knownStatus | The TskData.FileKnown value to associate with the new tag name. |
TskCoreException |
Definition at line 540 of file TaggingManager.java.
References org.sleuthkit.datamodel.SleuthkitCase.acquireSingleUserCaseWriteLock(), and org.sleuthkit.datamodel.SleuthkitCase.releaseSingleUserCaseWriteLock().
Referenced by org.sleuthkit.datamodel.SleuthkitCase.addOrUpdateTagName().
TagSet org.sleuthkit.datamodel.TaggingManager.addTagSet | ( | String | name, |
List< TagName > | tagNames | ||
) | throws TskCoreException |
Inserts a row into the tag_sets table in the case database.
name | The tag set name. |
tagNames |
TskCoreException |
Definition at line 91 of file TaggingManager.java.
References org.sleuthkit.datamodel.SleuthkitCase.beginTransaction(), org.sleuthkit.datamodel.SleuthkitCase.CaseDbTransaction.commit(), org.sleuthkit.datamodel.TagName.getColor(), org.sleuthkit.datamodel.SleuthkitCase.getDatabaseType(), org.sleuthkit.datamodel.TagName.getDescription(), org.sleuthkit.datamodel.TagName.getDisplayName(), org.sleuthkit.datamodel.TagName.getId(), org.sleuthkit.datamodel.TagName.getKnownStatus(), and org.sleuthkit.datamodel.SleuthkitCase.CaseDbTransaction.rollback().
void org.sleuthkit.datamodel.TaggingManager.deleteTagSet | ( | TagSet | tagSet | ) | throws TskCoreException |
Remove a row from the tag set table. If the given TagSet has a valid list of TagNames the TagNames will be removed from the tag_name table if there are not references to the TagNames in the content_tag or blackboard_artifact_tag table.
tagSet | TagSet to be deleted. |
TskCoreException |
Definition at line 152 of file TaggingManager.java.
References org.sleuthkit.datamodel.SleuthkitCase.beginTransaction(), org.sleuthkit.datamodel.SleuthkitCase.CaseDbTransaction.commit(), and org.sleuthkit.datamodel.SleuthkitCase.CaseDbTransaction.rollback().
TagName org.sleuthkit.datamodel.TaggingManager.getTagName | ( | long | id | ) | throws TskCoreException |
Return the TagName object for the given id.
id | The TagName id. |
TskCoreException |
Definition at line 595 of file TaggingManager.java.
References org.sleuthkit.datamodel.SleuthkitCase.acquireSingleUserCaseReadLock(), org.sleuthkit.datamodel.TagName.HTML_COLOR.getColorByName(), org.sleuthkit.datamodel.SleuthkitCase.releaseSingleUserCaseReadLock(), and org.sleuthkit.datamodel.TskData.FileKnown.valueOf().
TagSet org.sleuthkit.datamodel.TaggingManager.getTagSet | ( | TagName | tagName | ) | throws TskCoreException |
Gets the tag set a tag name (tag definition) belongs to, if any.
tagName | The tag name. |
TskCoreException | If there is an error querying the case database. |
Definition at line 192 of file TaggingManager.java.
References org.sleuthkit.datamodel.SleuthkitCase.acquireSingleUserCaseReadLock(), and org.sleuthkit.datamodel.SleuthkitCase.releaseSingleUserCaseReadLock().
TagSet org.sleuthkit.datamodel.TaggingManager.getTagSet | ( | long | id | ) | throws TskCoreException |
Return a TagSet object for the given id.
id | TagSet id. |
TskCoreException |
Definition at line 228 of file TaggingManager.java.
References org.sleuthkit.datamodel.SleuthkitCase.acquireSingleUserCaseReadLock(), and org.sleuthkit.datamodel.SleuthkitCase.releaseSingleUserCaseReadLock().
List<TagSet> org.sleuthkit.datamodel.TaggingManager.getTagSets | ( | ) | throws TskCoreException |
Returns a list of all the TagSets that exist in the case.
TskCoreException |
Definition at line 61 of file TaggingManager.java.
References org.sleuthkit.datamodel.SleuthkitCase.acquireSingleUserCaseReadLock(), and org.sleuthkit.datamodel.SleuthkitCase.releaseSingleUserCaseReadLock().
Copyright © 2011-2021 Brian Carrier. (carrier -at- sleuthkit -dot- org)
This work is licensed under a
Creative Commons Attribution-Share Alike 3.0 United States License.