Autopsy  4.18.0
Graphical digital forensics platform for The Sleuth Kit and other tools.
Classes | Public Member Functions | Static Public Member Functions | Static Private Member Functions | Private Attributes | Static Private Attributes | List of all members
org.sleuthkit.autopsy.centralrepository.datamodel.Persona Class Reference

Classes

class  CaseForAccountInstanceQueryCallback
 
enum  Confidence
 
class  DatasourceForAccountInstanceQueryCallback
 
class  PersonaFromAccountInstanceQueryCallback
 
class  PersonaQueryCallback
 
enum  PersonaStatus
 

Public Member Functions

PersonaAccount addAccount (CentralRepoAccount account, String justification, Persona.Confidence confidence) throws CentralRepoException
 
PersonaAlias addAlias (String alias, String justification, Persona.Confidence confidence) throws CentralRepoException
 
PersonaMetadata addMetadata (String name, String value, String justification, Persona.Confidence confidence) throws CentralRepoException
 
void delete () throws CentralRepoException
 
boolean equals (Object obj)
 
Collection< PersonaAliasgetAliases () throws CentralRepoException
 
Collection< CorrelationCasegetCases () throws CentralRepoException
 
String getComment ()
 
long getCreatedDate ()
 
Collection< CorrelationDataSourcegetDataSources () throws CentralRepoException
 
CentralRepoExaminer getExaminer ()
 
long getId ()
 
Collection< PersonaMetadatagetMetadata () throws CentralRepoException
 
long getModifiedDate ()
 
String getName ()
 
Collection< PersonaAccountgetPersonaAccounts () throws CentralRepoException
 
PersonaStatus getStatus ()
 
String getUuidStr ()
 
int hashCode ()
 
void modifyAccount (PersonaAccount account, Confidence confidence, String justification) throws CentralRepoException
 
void modifyAlias (PersonaAlias key, Confidence confidence, String justification) throws CentralRepoException
 
void modifyMetadata (PersonaMetadata key, Confidence confidence, String justification) throws CentralRepoException
 
void removeAccount (PersonaAccount account) throws CentralRepoException
 
void removeAlias (PersonaAlias alias) throws CentralRepoException
 
void removeMetadata (PersonaMetadata metadata) throws CentralRepoException
 
void setComment (String comment) throws CentralRepoException
 
void setName (String name) throws CentralRepoException
 

Static Public Member Functions

static Persona createPersonaForAccount (String personaName, String comment, PersonaStatus status, CentralRepoAccount account, String justification, Persona.Confidence confidence) throws CentralRepoException
 
static String getDefaultName ()
 
static Collection< PersonagetPersonaByAccountIdentifierLike (String partialName) throws CentralRepoException
 
static Collection< PersonagetPersonaByName (String partialName) throws CentralRepoException
 
static Collection< PersonagetPersonasForCase (CorrelationCase correlationCase) throws CentralRepoException
 
static Collection< PersonagetPersonasForDataSource (CorrelationDataSource dataSource) throws CentralRepoException
 

Static Private Member Functions

static Persona createPersona (String name, String comment, PersonaStatus status) throws CentralRepoException
 
static CentralRepository getCRInstance () throws CentralRepoException
 
static String getLikeEscaped (String initial)
 
static Persona getPersonaByUUID (String uuid) throws CentralRepoException
 
static String getPersonaFromInstanceTableQueryTemplate (CentralRepoAccount.CentralRepoAccountType crAccountType) throws CentralRepoException
 

Private Attributes

final String comment
 
final long createdDate
 
final CentralRepoExaminer examiner
 
final long id
 
final long modifiedDate
 
final String name
 
final PersonaStatus status
 
final String uuidStr
 

Static Private Attributes

static final String PERSONA_QUERY
 

Detailed Description

This class abstracts a persona.

An examiner may create a persona from an account.

Definition at line 39 of file Persona.java.

Member Function Documentation

PersonaAccount org.sleuthkit.autopsy.centralrepository.datamodel.Persona.addAccount ( CentralRepoAccount  account,
String  justification,
Persona.Confidence  confidence 
) throws CentralRepoException

Associates an account with a persona by creating a row in the PersonaAccounts table.

Parameters
accountAccount to add to persona.
justificationReason for adding the account to persona, may be null.
confidenceConfidence level.
Returns
PersonaAccount
Exceptions
CentralRepoExceptionIf there is an error.

Definition at line 309 of file Persona.java.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.Persona.createPersonaForAccount().

PersonaAlias org.sleuthkit.autopsy.centralrepository.datamodel.Persona.addAlias ( String  alias,
String  justification,
Persona.Confidence  confidence 
) throws CentralRepoException

Creates an alias for the Persona.

Parameters
aliasAlias name.
justificationReason for assigning the alias, may be null.
confidenceConfidence level.
Returns
PersonaAlias
Exceptions
CentralRepoExceptionIf there is an error in creating the alias.

Definition at line 522 of file Persona.java.

PersonaMetadata org.sleuthkit.autopsy.centralrepository.datamodel.Persona.addMetadata ( String  name,
String  value,
String  justification,
Persona.Confidence  confidence 
) throws CentralRepoException

Adds specified metadata to the persona.

Parameters
nameMetadata name.
valueMetadata value.
justificationReason for adding the metadata, may be null.
confidenceConfidence level.
Returns
PersonaMetadata
Exceptions
CentralRepoExceptionIf there is an error in adding metadata.

Definition at line 575 of file Persona.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.Persona.getId().

static Persona org.sleuthkit.autopsy.centralrepository.datamodel.Persona.createPersona ( String  name,
String  comment,
PersonaStatus  status 
) throws CentralRepoException
staticprivate
static Persona org.sleuthkit.autopsy.centralrepository.datamodel.Persona.createPersonaForAccount ( String  personaName,
String  comment,
PersonaStatus  status,
CentralRepoAccount  account,
String  justification,
Persona.Confidence  confidence 
) throws CentralRepoException
static

Creates a Persona and associates the specified account with it.

Parameters
personaNamePersona name.
commentComment to associate with persona, may be null.
statusPersona status
accountAccount for which the persona is being created.
justificationJustification for why this account belongs to this persona, may be null.
confidenceConfidence level for this association of Persona & account.
Returns
Persona Persona created.
Exceptions
CentralRepoExceptionIf there is an error creating the Persona.

Definition at line 216 of file Persona.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.Persona.addAccount(), and org.sleuthkit.autopsy.centralrepository.datamodel.Persona.createPersona().

void org.sleuthkit.autopsy.centralrepository.datamodel.Persona.delete ( ) throws CentralRepoException
boolean org.sleuthkit.autopsy.centralrepository.datamodel.Persona.equals ( Object  obj)
Collection<PersonaAlias> org.sleuthkit.autopsy.centralrepository.datamodel.Persona.getAliases ( ) throws CentralRepoException

Gets all aliases for the persona.

Returns
A collection of aliases, may be empty.
Exceptions
CentralRepoExceptionIf there is an error in retrieving aliases.

Definition at line 559 of file Persona.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.Persona.getId(), and org.sleuthkit.autopsy.centralrepository.datamodel.PersonaAlias.getPersonaAliases().

Referenced by org.sleuthkit.autopsy.centralrepository.persona.PersonaDetailsPanel.loadPersona().

Collection<CorrelationCase> org.sleuthkit.autopsy.centralrepository.datamodel.Persona.getCases ( ) throws CentralRepoException
String org.sleuthkit.autopsy.centralrepository.datamodel.Persona.getComment ( )
long org.sleuthkit.autopsy.centralrepository.datamodel.Persona.getCreatedDate ( )
static CentralRepository org.sleuthkit.autopsy.centralrepository.datamodel.Persona.getCRInstance ( ) throws CentralRepoException
staticprivate
Collection<CorrelationDataSource> org.sleuthkit.autopsy.centralrepository.datamodel.Persona.getDataSources ( ) throws CentralRepoException
static String org.sleuthkit.autopsy.centralrepository.datamodel.Persona.getDefaultName ( )
static
CentralRepoExaminer org.sleuthkit.autopsy.centralrepository.datamodel.Persona.getExaminer ( )
long org.sleuthkit.autopsy.centralrepository.datamodel.Persona.getId ( )
static String org.sleuthkit.autopsy.centralrepository.datamodel.Persona.getLikeEscaped ( String  initial)
staticprivate

Escapes string for use with like statements removing '', '_', '\'. This uses '!' as the escape character and the sql should reflect this accordingly. See https://stackoverflow.com/questions/8247970/using-like-wildcard-in-prepared-statement, https://www.postgresql.org/docs/8.3/functions-matching.html and https://www.sqlite.org/lang_expr.html for more information.

Parameters
initialThe initial string.
Returns
The resulting string.

Definition at line 466 of file Persona.java.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.Persona.getPersonaByAccountIdentifierLike(), and org.sleuthkit.autopsy.centralrepository.datamodel.Persona.getPersonaByName().

Collection<PersonaMetadata> org.sleuthkit.autopsy.centralrepository.datamodel.Persona.getMetadata ( ) throws CentralRepoException

Gets all metadata for the persona.

Returns
A collection of metadata, may be empty.
Exceptions
CentralRepoExceptionIf there is an error in retrieving aliases.

Definition at line 612 of file Persona.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.Persona.getId().

Referenced by org.sleuthkit.autopsy.centralrepository.persona.PersonaDetailsPanel.loadPersona().

long org.sleuthkit.autopsy.centralrepository.datamodel.Persona.getModifiedDate ( )
String org.sleuthkit.autopsy.centralrepository.datamodel.Persona.getName ( )
Collection<PersonaAccount> org.sleuthkit.autopsy.centralrepository.datamodel.Persona.getPersonaAccounts ( ) throws CentralRepoException
static Collection<Persona> org.sleuthkit.autopsy.centralrepository.datamodel.Persona.getPersonaByAccountIdentifierLike ( String  partialName) throws CentralRepoException
static

Gets the rows from the Personas table where persona accounts' names are similar to the given one. Persona marked as DELETED are not returned.

Parameters
partialNameName substring to match.
Returns
Collection of personas matching the given name substring, may be empty if no match is found.
Exceptions
CentralRepoExceptionIf there is an error in querying the Personas table.

Definition at line 489 of file Persona.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.Persona.PersonaStatus.DELETED, org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.executeQuery(), org.sleuthkit.autopsy.centralrepository.datamodel.Persona.getCRInstance(), and org.sleuthkit.autopsy.centralrepository.datamodel.Persona.getLikeEscaped().

Referenced by org.sleuthkit.autopsy.centralrepository.persona.PersonasTopComponent.executeSearch().

static Collection<Persona> org.sleuthkit.autopsy.centralrepository.datamodel.Persona.getPersonaByName ( String  partialName) throws CentralRepoException
static

Gets the rows from the Personas table with matching name. Persona marked as DELETED are not returned.

Parameters
partialNameName substring to match.
Returns
Collection of personas matching the given name substring, may be empty if no match is found.
Exceptions
CentralRepoExceptionIf there is an error in querying the Personas table.

Definition at line 438 of file Persona.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.Persona.PersonaStatus.DELETED, org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.executeQuery(), org.sleuthkit.autopsy.centralrepository.datamodel.Persona.getCRInstance(), org.sleuthkit.autopsy.centralrepository.datamodel.Persona.getLikeEscaped(), and org.sleuthkit.autopsy.centralrepository.datamodel.Persona.PERSONA_QUERY.

Referenced by org.sleuthkit.autopsy.centralrepository.persona.PersonasTopComponent.executeSearch().

static Persona org.sleuthkit.autopsy.centralrepository.datamodel.Persona.getPersonaByUUID ( String  uuid) throws CentralRepoException
staticprivate

Gets the row from the Personas table with the given UUID, creates and returns the Persona from that data.

Parameters
uuidPersona UUID to match.
Returns
Persona matching the given UUID, may be null if no match is found.
Exceptions
CentralRepoExceptionIf there is an error in querying the Personas table.

Definition at line 409 of file Persona.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.executeQuery(), org.sleuthkit.autopsy.centralrepository.datamodel.Persona.getCRInstance(), and org.sleuthkit.autopsy.centralrepository.datamodel.Persona.PERSONA_QUERY.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.Persona.createPersona().

static String org.sleuthkit.autopsy.centralrepository.datamodel.Persona.getPersonaFromInstanceTableQueryTemplate ( CentralRepoAccount.CentralRepoAccountType  crAccountType) throws CentralRepoException
staticprivate
static Collection<Persona> org.sleuthkit.autopsy.centralrepository.datamodel.Persona.getPersonasForCase ( CorrelationCase  correlationCase) throws CentralRepoException
static
static Collection<Persona> org.sleuthkit.autopsy.centralrepository.datamodel.Persona.getPersonasForDataSource ( CorrelationDataSource  dataSource) throws CentralRepoException
static
PersonaStatus org.sleuthkit.autopsy.centralrepository.datamodel.Persona.getStatus ( )
String org.sleuthkit.autopsy.centralrepository.datamodel.Persona.getUuidStr ( )
int org.sleuthkit.autopsy.centralrepository.datamodel.Persona.hashCode ( )

Definition at line 175 of file Persona.java.

void org.sleuthkit.autopsy.centralrepository.datamodel.Persona.modifyAccount ( PersonaAccount  account,
Confidence  confidence,
String  justification 
) throws CentralRepoException

Modifies the confidence / justification of the given PersonaAccount

Parameters
accountAccount to modify.
confidenceLevel of confidence.
justificationJustification.
Exceptions
CentralRepoExceptionIf there is an error in querying the Personas table.

Definition at line 335 of file Persona.java.

void org.sleuthkit.autopsy.centralrepository.datamodel.Persona.modifyAlias ( PersonaAlias  key,
Confidence  confidence,
String  justification 
) throws CentralRepoException

Modifies the given alias.

Parameters
keyKey for the alias to modify.
confidenceLevel of confidence.
justificationJustification.
Exceptions
CentralRepoExceptionIf there is an error in querying the Personas table.

Definition at line 548 of file Persona.java.

void org.sleuthkit.autopsy.centralrepository.datamodel.Persona.modifyMetadata ( PersonaMetadata  key,
Confidence  confidence,
String  justification 
) throws CentralRepoException

Modifies the given metadata.

Parameters
keyKey for the metadata to modify.
confidenceLevel of confidence.
justificationJustification.
Exceptions
CentralRepoExceptionIf there is an error in querying the Personas table.

Definition at line 601 of file Persona.java.

void org.sleuthkit.autopsy.centralrepository.datamodel.Persona.removeAccount ( PersonaAccount  account) throws CentralRepoException

Removes the given PersonaAccount (persona/account association)

Parameters
accountaccount to remove
Exceptions
CentralRepoExceptionIf there is an error in querying the Personas table.

Definition at line 321 of file Persona.java.

void org.sleuthkit.autopsy.centralrepository.datamodel.Persona.removeAlias ( PersonaAlias  alias) throws CentralRepoException

Removes the given alias.

Parameters
aliasalias to remove
Exceptions
CentralRepoExceptionIf there is an error in querying the Personas table.

Definition at line 534 of file Persona.java.

void org.sleuthkit.autopsy.centralrepository.datamodel.Persona.removeMetadata ( PersonaMetadata  metadata) throws CentralRepoException

Removes the given metadata from this persona.

Parameters
metadatametadata to remove
Exceptions
CentralRepoExceptionIf there is an error in querying the Personas table.

Definition at line 587 of file Persona.java.

void org.sleuthkit.autopsy.centralrepository.datamodel.Persona.setComment ( String  comment) throws CentralRepoException
void org.sleuthkit.autopsy.centralrepository.datamodel.Persona.setName ( String  name) throws CentralRepoException

Member Data Documentation

final String org.sleuthkit.autopsy.centralrepository.datamodel.Persona.comment
private
final long org.sleuthkit.autopsy.centralrepository.datamodel.Persona.createdDate
private
final CentralRepoExaminer org.sleuthkit.autopsy.centralrepository.datamodel.Persona.examiner
private
final long org.sleuthkit.autopsy.centralrepository.datamodel.Persona.id
private
final long org.sleuthkit.autopsy.centralrepository.datamodel.Persona.modifiedDate
private
final String org.sleuthkit.autopsy.centralrepository.datamodel.Persona.name
private
final String org.sleuthkit.autopsy.centralrepository.datamodel.Persona.PERSONA_QUERY
staticprivate
Initial value:
= "SELECT p.id, p.uuid, p.name, p.comment, p.created_date, p.modified_date, p.status_id, p.examiner_id, e.login_name, e.display_name "
+ "FROM personas as p "
+ "INNER JOIN examiners as e ON e.id = p.examiner_id "

Definition at line 393 of file Persona.java.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.Persona.getPersonaByName(), and org.sleuthkit.autopsy.centralrepository.datamodel.Persona.getPersonaByUUID().

final PersonaStatus org.sleuthkit.autopsy.centralrepository.datamodel.Persona.status
private
final String org.sleuthkit.autopsy.centralrepository.datamodel.Persona.uuidStr
private

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

Copyright © 2012-2021 Basis Technology. Generated on: Thu Jul 8 2021
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.