Public Member Functions
org.sleuthkit.datamodel.Account.Type	addAccountType (String accountTypeName, String displayName) throws TskCoreException

void	addRelationships (AccountFileInstance sender, List< AccountFileInstance > recipients, BlackboardArtifact sourceArtifact, org.sleuthkit.datamodel.Relationship.Type relationshipType, long dateTime) throws TskCoreException, TskDataException

AccountFileInstance	createAccountFileInstance (org.sleuthkit.datamodel.Account.Type accountType, String accountUniqueID, String moduleName, Content sourceFile) throws TskCoreException

Account	getAccount (org.sleuthkit.datamodel.Account.Type accountType, String accountUniqueID) throws TskCoreException

List< AccountDeviceInstance >	getAccountDeviceInstancesWithRelationships (CommunicationsFilter filter) throws TskCoreException

org.sleuthkit.datamodel.Account.Type	getAccountType (String accountTypeName) throws TskCoreException

Set< Content >	getRelationshipSources (Set< AccountDeviceInstance > accountDeviceInstanceList, CommunicationsFilter filter) throws TskCoreException

long	getRelationshipSourcesCount (AccountDeviceInstance accountDeviceInstance, CommunicationsFilter filter) throws TskCoreException

Detailed Description

Provides an API to create Accounts and communications/relationships between accounts.

Definition at line 45 of file CommunicationsManager.java.

Member Function Documentation

org.sleuthkit.datamodel.Account.Type org.sleuthkit.datamodel.CommunicationsManager.addAccountType	(	String	accountTypeName,
		String	displayName
	)		throws TskCoreException

Add a custom account type that is not already defined in Account.Type. Will not allow duplicates and will return existing type if the name is already defined.

@param accountTypeName account type that must be unique
@param displayName     account type display name

@return Account.Type

@throws TskCoreException exception thrown if a critical error occurs
                         within TSK core

Definition at line 193 of file CommunicationsManager.java.

References org.sleuthkit.datamodel.SleuthkitCase.acquireSingleUserCaseWriteLock(), and org.sleuthkit.datamodel.SleuthkitCase.releaseSingleUserCaseWriteLock().

void org.sleuthkit.datamodel.CommunicationsManager.addRelationships	(	AccountFileInstance	sender,
		List< AccountFileInstance >	recipients,
		BlackboardArtifact	sourceArtifact,
		org.sleuthkit.datamodel.Relationship.Type	relationshipType,
		long	dateTime
	)		throws TskCoreException, TskDataException

Add one or more relationships between the sender and recipient account instances. All account instances must be from the same data source.

Parameters

sender	sender account
recipients	list of recipients
sourceArtifact	Artifact that relationships were derived from
relationshipType	The type of relationships to be created
dateTime	Date of communications/relationship, as epoch seconds

Exceptions

org.sleuthkit.datamodel.TskCoreException
org.sleuthkit.datamodel.TskDataException	If the all the accounts and the relationship are not from the same data source, or if the sourceArtifact and relationshipType are not compatible.

Definition at line 364 of file CommunicationsManager.java.

AccountFileInstance org.sleuthkit.datamodel.CommunicationsManager.createAccountFileInstance	(	org.sleuthkit.datamodel.Account.Type	accountType,
		String	accountUniqueID,
		String	moduleName,
		Content	sourceFile
	)		throws TskCoreException

Records that an account was used in a specific file. Behind the scenes, it will create a case-specific Account object if it does not already exist and create the needed database entries (which currently include making a BlackboardArtifact.

Parameters

accountType	account type
accountUniqueID	unique account identifier (such as email address)
moduleName	module creating the account
sourceFile	source file the account was found in (for the blackboard)

Returns: AccountFileInstance

Exceptions

TskCoreException exception thrown if a critical error occurs within TSK core

Definition at line 264 of file CommunicationsManager.java.

Account org.sleuthkit.datamodel.CommunicationsManager.getAccount	(	org.sleuthkit.datamodel.Account.Type	accountType,
		String	accountUniqueID
	)		throws TskCoreException

Get the Account with the given account type and account ID.

Parameters

accountType	account type
accountUniqueID	unique account identifier (such as an email address)

Returns: Account, returns NULL is no matching account found

Exceptions

TskCoreException exception thrown if a critical error occurs within TSK core

Definition at line 299 of file CommunicationsManager.java.

References org.sleuthkit.datamodel.SleuthkitCase.acquireSingleUserCaseReadLock(), and org.sleuthkit.datamodel.SleuthkitCase.releaseSingleUserCaseReadLock().

List<AccountDeviceInstance> org.sleuthkit.datamodel.CommunicationsManager.getAccountDeviceInstancesWithRelationships ( CommunicationsFilter filter ) throws TskCoreException

Returns a list of AccountDeviceInstances that at least one relationship that meets the criteria listed in the filters.

Applicable filters: DeviceFilter, AccountTypeFilter, DateRangeFilter,
RelationshipTypeFilter

@param filter filters to apply

@return list of AccountDeviceInstances

@throws TskCoreException exception thrown if a critical error occurs
                         within TSK core

Definition at line 708 of file CommunicationsManager.java.

References org.sleuthkit.datamodel.SleuthkitCase.acquireSingleUserCaseReadLock(), org.sleuthkit.datamodel.SleuthkitCase.getDatabaseType(), and org.sleuthkit.datamodel.SleuthkitCase.releaseSingleUserCaseReadLock().

org.sleuthkit.datamodel.Account.Type org.sleuthkit.datamodel.CommunicationsManager.getAccountType ( String accountTypeName ) throws TskCoreException

Get the Account.Type for the give type name.

Parameters

accountTypeName An attribute type name.

Returns: An account type or null if the account type does not exist.

Exceptions

TskCoreException If an error occurs accessing the case database.

Definition at line 570 of file CommunicationsManager.java.

References org.sleuthkit.datamodel.SleuthkitCase.acquireSingleUserCaseReadLock(), and org.sleuthkit.datamodel.SleuthkitCase.releaseSingleUserCaseReadLock().

Set<Content> org.sleuthkit.datamodel.CommunicationsManager.getRelationshipSources	(	Set< AccountDeviceInstance >	accountDeviceInstanceList,
		CommunicationsFilter	filter
	)		throws TskCoreException

Get the unique relationship sources (such as EMAIL artifacts) associated with an account on a given device (AccountDeviceInstance) that meet the filter criteria.

Applicable filters: RelationshipTypeFilter, DateRangeFilter

@param accountDeviceInstanceList set of account device instances for
                                 which to get the relationship sources.
@param filter                    Filters to apply.

@return number of relationship sources found for given account(s).

@throws org.sleuthkit.datamodel.TskCoreException

Definition at line 872 of file CommunicationsManager.java.

References org.sleuthkit.datamodel.SleuthkitCase.acquireSingleUserCaseReadLock(), org.sleuthkit.datamodel.SleuthkitCase.getArtifactType(), org.sleuthkit.datamodel.SleuthkitCase.releaseSingleUserCaseReadLock(), and org.sleuthkit.datamodel.BlackboardArtifact.ReviewStatus.withID().

long org.sleuthkit.datamodel.CommunicationsManager.getRelationshipSourcesCount	(	AccountDeviceInstance	accountDeviceInstance,
		CommunicationsFilter	filter
	)		throws TskCoreException

Get the number of unique relationship sources (such as EMAIL artifacts) associated with an account on a given device (AccountDeviceInstance) that meet the filter criteria.

Applicable filters: RelationshipTypeFilter, DateRangeFilter

@param accountDeviceInstance Account of interest
@param filter                Filters to apply.

@return number of account relationships found for this account.

@throws org.sleuthkit.datamodel.TskCoreException

Definition at line 814 of file CommunicationsManager.java.

References org.sleuthkit.datamodel.SleuthkitCase.acquireSingleUserCaseReadLock(), and org.sleuthkit.datamodel.SleuthkitCase.releaseSingleUserCaseReadLock().

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

/home/carriersleuth/repos/sleuthkit/bindings/java/src/org/sleuthkit/datamodel/CommunicationsManager.java

Public Member Functions

Detailed Description

Member Function Documentation