Sleuth Kit Java Bindings (JNI)  4.12.1
Java bindings for using The Sleuth Kit
org.sleuthkit.datamodel.OsAccount Class Reference

Inherits org.sleuthkit.datamodel.AbstractContent.

Classes

class  OsAccountAttribute
 
enum  OsAccountDbStatus
 
enum  OsAccountStatus
 
enum  OsAccountType
 

Public Member Functions

void close ()
 
Optional< String > getAddr ()
 
Optional< Long > getCreationTime ()
 
synchronized List< OsAccountAttributegetExtendedOsAccountAttributes () throws TskCoreException
 
Optional< String > getFullName ()
 
long getId ()
 
Optional< String > getLoginName ()
 
OsAccountDbStatus getOsAccountDbStatus ()
 
synchronized List< OsAccountInstancegetOsAccountInstances () throws TskCoreException
 
Optional< OsAccountStatusgetOsAccountStatus ()
 
Optional< OsAccountTypegetOsAccountType ()
 
long getRealmId ()
 
long getSize ()
 
SleuthkitCase getSleuthkitCase ()
 
int read (byte[] buf, long offset, long len) throws TskCoreException
 
- Public Member Functions inherited from org.sleuthkit.datamodel.AbstractContent
boolean equals (Object obj)
 
Score getAggregateScore () throws TskCoreException
 
List< AnalysisResultgetAllAnalysisResults () throws TskCoreException
 
ArrayList< BlackboardArtifactgetAllArtifacts () throws TskCoreException
 
long getAllArtifactsCount () throws TskCoreException
 
List< DataArtifactgetAllDataArtifacts () throws TskCoreException
 
List< AnalysisResultgetAnalysisResults (BlackboardArtifact.Type artifactType) throws TskCoreException
 
ArrayList< BlackboardArtifactgetArtifacts (String artifactTypeName) throws TskCoreException
 
ArrayList< BlackboardArtifactgetArtifacts (int artifactTypeID) throws TskCoreException
 
ArrayList< BlackboardArtifactgetArtifacts (BlackboardArtifact.ARTIFACT_TYPE type) throws TskCoreException
 
long getArtifactsCount (String artifactTypeName) throws TskCoreException
 
long getArtifactsCount (int artifactTypeID) throws TskCoreException
 
long getArtifactsCount (ARTIFACT_TYPE type) throws TskCoreException
 
List< ContentgetChildren () throws TskCoreException
 
int getChildrenCount () throws TskCoreException
 
List< Long > getChildrenIds () throws TskCoreException
 
Content getDataSource () throws TskCoreException
 
BlackboardArtifact getGenInfoArtifact () throws TskCoreException
 
BlackboardArtifact getGenInfoArtifact (boolean create) throws TskCoreException
 
ArrayList< BlackboardAttributegetGenInfoAttributes (ATTRIBUTE_TYPE attr_type) throws TskCoreException
 
Set< String > getHashSetNames () throws TskCoreException
 
long getId ()
 
String getName ()
 
Content getParent () throws TskCoreException
 
Optional< Long > getParentId () throws TskCoreException
 
SleuthkitCase getSleuthkitCase ()
 
String getUniquePath () throws TskCoreException
 
boolean hasChildren () throws TskCoreException
 
int hashCode ()
 
AnalysisResultAdded newAnalysisResult (BlackboardArtifact.Type artifactType, Score score, String conclusion, String configuration, String justification, Collection< BlackboardAttribute > attributesList) throws TskCoreException
 
AnalysisResultAdded newAnalysisResult (BlackboardArtifact.Type artifactType, Score score, String conclusion, String configuration, String justification, Collection< BlackboardAttribute > attributesList, long dataSourceId) throws TskCoreException
 
BlackboardArtifact newArtifact (int artifactTypeID) throws TskCoreException
 
BlackboardArtifact newArtifact (BlackboardArtifact.ARTIFACT_TYPE type) throws TskCoreException
 
DataArtifact newDataArtifact (BlackboardArtifact.Type artifactType, Collection< BlackboardAttribute > attributesList, Long osAccountId) throws TskCoreException
 
DataArtifact newDataArtifact (BlackboardArtifact.Type artifactType, Collection< BlackboardAttribute > attributesList, Long osAccountId, long dataSourceId) throws TskCoreException
 
DataArtifact newDataArtifact (BlackboardArtifact.Type artifactType, Collection< BlackboardAttribute > attributesList) throws TskCoreException
 
String toString ()
 
String toString (boolean preserveState)
 
- Public Member Functions inherited from org.sleuthkit.datamodel.Content
long getArtifactsCount (BlackboardArtifact.ARTIFACT_TYPE type) throws TskCoreException
 
ArrayList< BlackboardAttributegetGenInfoAttributes (BlackboardAttribute.ATTRIBUTE_TYPE attr_type) throws TskCoreException
 

Additional Inherited Members

- Static Public Attributes inherited from org.sleuthkit.datamodel.AbstractContent
static final long UNKNOWN_ID = -1
 
- Protected Member Functions inherited from org.sleuthkit.datamodel.AbstractContent
 AbstractContent (SleuthkitCase db, long obj_id, String name)
 
- Protected Attributes inherited from org.sleuthkit.datamodel.AbstractContent
long parentId
 

Detailed Description

Abstracts an OS user account. OS Accounts have a scope, which is defined by their parent OsAccountRealm.

An OS user account may own files and (some) artifacts.

OsAcounts can be created with minimal data and updated as more is learned. Caller must call update() to save any new data.

Definition at line 35 of file OsAccount.java.

Member Function Documentation

void org.sleuthkit.datamodel.OsAccount.close ( )

Free native resources after read is done on the Content object. After closing, read can be called again on the same Content object, which should result in re-opening of new native resources.

Implements org.sleuthkit.datamodel.Content.

Definition at line 388 of file OsAccount.java.

Optional<String> org.sleuthkit.datamodel.OsAccount.getAddr ( )

Get the unique identifier for the account, such as UID or SID. The id is unique within the account realm.

Returns
Optional unique identifier.

Definition at line 268 of file OsAccount.java.

Optional<Long> org.sleuthkit.datamodel.OsAccount.getCreationTime ( )

Get account creation time.

Returns
Optional with account creation time.

Definition at line 315 of file OsAccount.java.

synchronized List<OsAccountAttribute> org.sleuthkit.datamodel.OsAccount.getExtendedOsAccountAttributes ( ) throws TskCoreException

Get additional account attributes.

Returns
List of additional account attributes. May return an empty list.
Exceptions
TskCoreException

Definition at line 353 of file OsAccount.java.

References org.sleuthkit.datamodel.SleuthkitCase.getOsAccountManager().

Optional<String> org.sleuthkit.datamodel.OsAccount.getFullName ( )

Get account user full name, such as "John Doe"

Returns
Optional with full name.

Definition at line 306 of file OsAccount.java.

long org.sleuthkit.datamodel.OsAccount.getId ( )

Get the account Object Id that is unique within the scope of the case.

Returns
Account id.

Implements org.sleuthkit.datamodel.Content.

Definition at line 258 of file OsAccount.java.

Referenced by org.sleuthkit.datamodel.OsAccountManager.newOsAccountInstance(), and org.sleuthkit.datamodel.OsAccount.OsAccountAttribute.OsAccountAttribute().

Optional<String> org.sleuthkit.datamodel.OsAccount.getLoginName ( )

Get account login name, such as "jdoe"

Returns
Optional login name.

Definition at line 288 of file OsAccount.java.

OsAccountDbStatus org.sleuthkit.datamodel.OsAccount.getOsAccountDbStatus ( )

Get account status in the database.

Returns
Database account status.

Definition at line 342 of file OsAccount.java.

synchronized List<OsAccountInstance> org.sleuthkit.datamodel.OsAccount.getOsAccountInstances ( ) throws TskCoreException

Return the os account instances.

Returns
List of all the OsAccountInstances. May return an empty list.
Exceptions
TskCoreException

Definition at line 367 of file OsAccount.java.

References org.sleuthkit.datamodel.OsAccountManager.getOsAccountInstances(), and org.sleuthkit.datamodel.SleuthkitCase.getOsAccountManager().

Optional<OsAccountStatus> org.sleuthkit.datamodel.OsAccount.getOsAccountStatus ( )

Get account status.

Returns
Optional with account status.

Definition at line 333 of file OsAccount.java.

Optional<OsAccountType> org.sleuthkit.datamodel.OsAccount.getOsAccountType ( )

Get account type.

Returns
Optional with account type.

Definition at line 324 of file OsAccount.java.

long org.sleuthkit.datamodel.OsAccount.getRealmId ( )

Get the ID for the account realm. Get the Realm via OsAccountRealmManager.getRealmByRealmId() NOTE: The realm may get updated as more data is parsed, so listen for events to update as needed.

Returns

Definition at line 279 of file OsAccount.java.

long org.sleuthkit.datamodel.OsAccount.getSize ( )

Get the (reported) size of the content object and, in theory, how much you should be able to read from it. In some cases, data corruption may mean that you cannot read this much data.

Returns
size of the content in bytes

Implements org.sleuthkit.datamodel.Content.

Definition at line 393 of file OsAccount.java.

SleuthkitCase org.sleuthkit.datamodel.OsAccount.getSleuthkitCase ( )

Gets the SleuthKit case database for this account.

Returns
The SleuthKit case object.

Definition at line 377 of file OsAccount.java.

int org.sleuthkit.datamodel.OsAccount.read ( byte[]  buf,
long  offset,
long  len 
) throws TskCoreException

Reads data that this content object is associated with (file contents, volume contents, etc.).

Parameters
bufa character array of data (in bytes) to copy read data to
offsetbyte offset in the content to start reading from
lennumber of bytes to read into buf.
Returns
num of bytes read, or -1 on error
Exceptions
TskCoreExceptionif critical error occurred during read in the tsk core

Implements org.sleuthkit.datamodel.Content.

Definition at line 382 of file OsAccount.java.


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

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.