Autopsy  4.17.0
Graphical digital forensics platform for The Sleuth Kit and other tools.
Public Member Functions | Static Public Member Functions | List of all members
org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository Interface Reference

Inherited by org.sleuthkit.autopsy.centralrepository.datamodel.RdbmsCentralRepo.

Public Member Functions

void addArtifactInstance (CorrelationAttributeInstance eamArtifact) throws CentralRepoException
 
void addAttributeInstanceBulk (CorrelationAttributeInstance eamArtifact) throws CentralRepoException
 
void addDataSourceObjectId (int rowId, long dataSourceObjectId) throws CentralRepoException
 
void addReferenceInstance (CentralRepoFileInstance eamGlobalFileInstance, CorrelationAttributeInstance.Type correlationType) throws CentralRepoException
 
void bulkInsertCases (List< CorrelationCase > cases) throws CentralRepoException
 
void bulkInsertReferenceTypeEntries (Set< CentralRepoFileInstance > globalInstances, CorrelationAttributeInstance.Type contentType) throws CentralRepoException
 
void commitAttributeInstancesBulk () throws CentralRepoException
 
void deleteOrganization (CentralRepoOrganization organizationToDelete) throws CentralRepoException
 
void deleteReferenceSet (int referenceSetID) throws CentralRepoException
 
void executeCommand (String sql, List< Object > params) throws CentralRepoException
 
void executeQuery (String sql, List< Object > params, CentralRepositoryDbQueryCallback queryCallback) throws CentralRepoException
 
CentralRepoAccount getAccount (CentralRepoAccount.CentralRepoAccountType crAccountType, String accountUniqueID) throws InvalidAccountIDException, CentralRepoException
 
CentralRepoAccountType getAccountTypeByName (String accountTypeName) throws CentralRepoException
 
Collection< CentralRepoAccountTypegetAllAccountTypes () throws CentralRepoException
 
List< CentralRepoFileSetgetAllReferenceSets (CorrelationAttributeInstance.Type correlationType) throws CentralRepoException
 
List< CorrelationAttributeInstancegetArtifactInstancesByTypeValue (CorrelationAttributeInstance.Type aType, String value) throws CentralRepoException, CorrelationAttributeNormalizationException
 
List< CorrelationAttributeInstancegetArtifactInstancesByTypeValues (CorrelationAttributeInstance.Type aType, List< String > values) throws CentralRepoException, CorrelationAttributeNormalizationException
 
List< CorrelationAttributeInstancegetArtifactInstancesByTypeValuesAndCases (CorrelationAttributeInstance.Type aType, List< String > values, List< Integer > caseIds) throws CentralRepoException, CorrelationAttributeNormalizationException
 
CorrelationCase getCase (Case autopsyCase) throws CentralRepoException
 
CorrelationCase getCaseById (int caseId) throws CentralRepoException
 
CorrelationCase getCaseByUUID (String caseUUID) throws CentralRepoException
 
List< CorrelationCasegetCases () throws CentralRepoException
 
CorrelationAttributeInstance getCorrelationAttributeInstance (CorrelationAttributeInstance.Type type, CorrelationCase correlationCase, CorrelationDataSource correlationDataSource, String value, String filePath) throws CentralRepoException, CorrelationAttributeNormalizationException
 
CorrelationAttributeInstance getCorrelationAttributeInstance (CorrelationAttributeInstance.Type type, CorrelationCase correlationCase, CorrelationDataSource correlationDataSource, long objectID) throws CentralRepoException, CorrelationAttributeNormalizationException
 
CorrelationAttributeInstance.Type getCorrelationTypeById (int typeId) throws CentralRepoException
 
Long getCountArtifactInstancesByCaseDataSource (CorrelationDataSource correlationDataSource) throws CentralRepoException
 
Long getCountArtifactInstancesByTypeValue (CorrelationAttributeInstance.Type aType, String value) throws CentralRepoException, CorrelationAttributeNormalizationException
 
Long getCountArtifactInstancesKnownBad (CorrelationAttributeInstance.Type aType, String value) throws CentralRepoException, CorrelationAttributeNormalizationException
 
Long getCountUniqueCaseDataSourceTuplesHavingTypeValue (CorrelationAttributeInstance.Type aType, String value) throws CentralRepoException, CorrelationAttributeNormalizationException
 
Long getCountUniqueDataSources () throws CentralRepoException
 
CorrelationDataSource getDataSource (CorrelationCase correlationCase, Long caseDbDataSourceId) throws CentralRepoException
 
CorrelationDataSource getDataSourceById (CorrelationCase correlationCase, int dataSourceId) throws CentralRepoException
 
List< CorrelationDataSourcegetDataSources () throws CentralRepoException
 
String getDbInfo (String name) throws CentralRepoException
 
List< CorrelationAttributeInstance.Type > getDefinedCorrelationTypes () throws CentralRepoException
 
List< CorrelationAttributeInstance.Type > getEnabledCorrelationTypes () throws CentralRepoException
 
CoordinationService.Lock getExclusiveMultiUserDbLock () throws CentralRepoException
 
int getFrequencyPercentage (CorrelationAttributeInstance corAttr) throws CentralRepoException, CorrelationAttributeNormalizationException
 
List< String > getListCasesHavingArtifactInstances (CorrelationAttributeInstance.Type aType, String value) throws CentralRepoException, CorrelationAttributeNormalizationException
 
List< String > getListCasesHavingArtifactInstancesKnownBad (CorrelationAttributeInstance.Type aType, String value) throws CentralRepoException, CorrelationAttributeNormalizationException
 
CentralRepoAccount getOrCreateAccount (CentralRepoAccount.CentralRepoAccountType crAccountType, String accountUniqueID) throws InvalidAccountIDException, CentralRepoException
 
CentralRepoOrganization getOrganizationByID (int orgID) throws CentralRepoException
 
List< CentralRepoOrganizationgetOrganizations () throws CentralRepoException
 
CentralRepoExaminer getOrInsertExaminer (String examinerLoginName) throws CentralRepoException
 
List< CentralRepoFileInstancegetReferenceInstancesByTypeValue (CorrelationAttributeInstance.Type aType, String aValue) throws CentralRepoException, CorrelationAttributeNormalizationException
 
CentralRepoFileSet getReferenceSetByID (int globalSetID) throws CentralRepoException
 
CentralRepoOrganization getReferenceSetOrganization (int referenceSetID) throws CentralRepoException
 
List< CorrelationAttributeInstance.Type > getSupportedCorrelationTypes () throws CentralRepoException
 
boolean isArtifactKnownBadByReference (CorrelationAttributeInstance.Type aType, String value) throws CentralRepoException, CorrelationAttributeNormalizationException
 
boolean isFileHashInReferenceSet (String hash, int referenceSetID) throws CentralRepoException, CorrelationAttributeNormalizationException
 
boolean isValueInReferenceSet (String value, int referenceSetID, int correlationTypeID) throws CentralRepoException, CorrelationAttributeNormalizationException
 
HashHitInfo lookupHash (String hash, int referenceSetID) throws CentralRepoException, CorrelationAttributeNormalizationException
 
CorrelationCase newCase (CorrelationCase eamCase) throws CentralRepoException
 
CorrelationCase newCase (Case autopsyCase) throws CentralRepoException
 
int newCorrelationType (CorrelationAttributeInstance.Type newType) throws CentralRepoException
 
CorrelationDataSource newDataSource (CorrelationDataSource eamDataSource) throws CentralRepoException
 
void newDbInfo (String name, String value) throws CentralRepoException
 
CentralRepoOrganization newOrganization (CentralRepoOrganization eamOrg) throws CentralRepoException
 
int newReferenceSet (CentralRepoFileSet eamGlobalSet) throws CentralRepoException
 
void processInstanceTable (CorrelationAttributeInstance.Type type, InstanceTableCallback instanceTableCallback) throws CentralRepoException
 
void processInstanceTableWhere (CorrelationAttributeInstance.Type type, String whereClause, InstanceTableCallback instanceTableCallback) throws CentralRepoException
 
void processSelectClause (String selectClause, InstanceTableCallback instanceTableCallback) throws CentralRepoException
 
boolean referenceSetExists (String referenceSetName, String version) throws CentralRepoException
 
boolean referenceSetIsValid (int referenceSetID, String referenceSetName, String version) throws CentralRepoException
 
void reset () throws CentralRepoException
 
void saveSettings ()
 
void setAttributeInstanceKnownStatus (CorrelationAttributeInstance eamArtifact, TskData.FileKnown knownStatus) throws CentralRepoException
 
void shutdownConnections () throws CentralRepoException
 
void updateAttributeInstanceComment (CorrelationAttributeInstance eamArtifact) throws CentralRepoException
 
void updateCase (CorrelationCase eamCase) throws CentralRepoException
 
void updateCorrelationType (CorrelationAttributeInstance.Type aType) throws CentralRepoException
 
void updateDataSourceMd5Hash (CorrelationDataSource eamDataSource) throws CentralRepoException
 
void updateDataSourceName (CorrelationDataSource eamDataSource, String newName) throws CentralRepoException
 
void updateDataSourceSha1Hash (CorrelationDataSource eamDataSource) throws CentralRepoException
 
void updateDataSourceSha256Hash (CorrelationDataSource eamDataSource) throws CentralRepoException
 
void updateDbInfo (String name, String value) throws CentralRepoException
 
void updateOrganization (CentralRepoOrganization updatedOrganization) throws CentralRepoException
 
void updateSettings ()
 
void upgradeSchema () throws CentralRepoException, SQLException, IncompatibleCentralRepoException
 

Static Public Member Functions

static CentralRepository getInstance () throws CentralRepoException
 
static boolean isEnabled ()
 

Detailed Description

Main interface for interacting with the database

Definition at line 35 of file CentralRepository.java.

Member Function Documentation

void org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.addArtifactInstance ( CorrelationAttributeInstance  eamArtifact) throws CentralRepoException

Inserts new Artifact(s) into the database. Should add associated Case and Data Source first.

Parameters
eamArtifactThe artifact to add

Referenced by org.sleuthkit.autopsy.centralrepository.AddEditCentralRepoCommentAction.actionPerformed(), and org.sleuthkit.autopsy.centralrepository.eventlisteners.IngestEventsListener.DataAddedTask.run().

void org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.addAttributeInstanceBulk ( CorrelationAttributeInstance  eamArtifact) throws CentralRepoException

Adds an eamArtifact to an internal list to be later added to DB. Artifact can have 1 or more Artifact Instances. Insert will be triggered by a threshold or a call to commitAttributeInstancesBulk().

Parameters
eamArtifactThe artifact to add
void org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.addDataSourceObjectId ( int  rowId,
long  dataSourceObjectId 
) throws CentralRepoException

Set the data source object id for a specific entry in the data_sources table

Parameters
rowId- the row id for the data_sources table entry
dataSourceObjectId- the object id for the data source from the caseDb

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepositoryService.dataUpgradeForVersion1dot2().

void org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.addReferenceInstance ( CentralRepoFileInstance  eamGlobalFileInstance,
CorrelationAttributeInstance.Type  correlationType 
) throws CentralRepoException

Add a new reference instance

Parameters
eamGlobalFileInstanceThe reference instance to add
correlationTypeCorrelation Type that this Reference Instance is
Exceptions
CentralRepoException
void org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.bulkInsertCases ( List< CorrelationCase cases) throws CentralRepoException

Executes a bulk insert of the cases

void org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.bulkInsertReferenceTypeEntries ( Set< CentralRepoFileInstance globalInstances,
CorrelationAttributeInstance.Type  contentType 
) throws CentralRepoException

Insert the bulk collection of Global File Instances

Parameters
globalInstancesa Set of EamGlobalFileInstances to insert into the db.
contentTypethe Type of the global instances
Exceptions
CentralRepoException

Referenced by org.sleuthkit.autopsy.modules.hashdatabase.ImportCentralRepoDbProgressDialog.CentralRepoImportWorker.doInBackground().

void org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.commitAttributeInstancesBulk ( ) throws CentralRepoException

Executes a bulk insert of the eamArtifacts added from the addAttributeInstanceBulk() method

void org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.deleteOrganization ( CentralRepoOrganization  organizationToDelete) throws CentralRepoException

Delete an organization if it is not being used by any case.

Parameters
organizationToDeletethe organization to be deleted
Exceptions
CentralRepoException

Referenced by org.sleuthkit.autopsy.centralrepository.optionspanel.ManageOrganizationsDialog.deleteButtonActionPerformed().

void org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.deleteReferenceSet ( int  referenceSetID) throws CentralRepoException
void org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.executeCommand ( String  sql,
List< Object >  params 
) throws CentralRepoException

Executes an INSERT/UPDATE/DELETE sql as a prepared statement, on the central repository database.

Parameters
sqlsql to execute.
paramsList of query params to use, may be empty.
Exceptions
CentralRepoExceptionIf there is an error.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.Persona.createPersona(), org.sleuthkit.autopsy.centralrepository.datamodel.Persona.delete(), org.sleuthkit.autopsy.centralrepository.datamodel.Persona.setComment(), and org.sleuthkit.autopsy.centralrepository.datamodel.Persona.setName().

void org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.executeQuery ( String  sql,
List< Object >  params,
CentralRepositoryDbQueryCallback  queryCallback 
) throws CentralRepoException
CentralRepoAccount org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getAccount ( CentralRepoAccount.CentralRepoAccountType  crAccountType,
String  accountUniqueID 
) throws InvalidAccountIDException, CentralRepoException

Gets an account from the accounts table matching the given type/ID, if one exists.

Parameters
crAccountTypeCR account type to look for or create
accountUniqueIDtype specific unique account id
Returns
CR account, if found, null otherwise.
Exceptions
CentralRepoExceptionIf there is an error accessing Central Repository.
InvalidAccountIDExceptionIf the account identifier is not valid.

Referenced by org.sleuthkit.autopsy.contentviewers.artifactviewers.PersonaAccountFetcher.CreatePersonaButtonListener.actionPerformed(), org.sleuthkit.autopsy.contentviewers.artifactviewers.MessageAccountPanel.PersonaButtonListener.actionPerformed(), and org.sleuthkit.autopsy.contentviewers.artifactviewers.ContactArtifactViewer.ContactPersonaSearcherTask.doInBackground().

CentralRepoAccountType org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getAccountTypeByName ( String  accountTypeName) throws CentralRepoException
Collection<CentralRepoAccountType> org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getAllAccountTypes ( ) throws CentralRepoException
List<CentralRepoFileSet> org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getAllReferenceSets ( CorrelationAttributeInstance.Type  correlationType) throws CentralRepoException

Get all reference sets

Parameters
correlationTypeType of sets to return
Returns
List of all reference sets in the central repository
Exceptions
CentralRepoException

Referenced by org.sleuthkit.autopsy.modules.hashdatabase.HashDbManager.getCentralRepoHashSetsFromDatabase().

List<CorrelationAttributeInstance> org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getArtifactInstancesByTypeValue ( CorrelationAttributeInstance.Type  aType,
String  value 
) throws CentralRepoException, CorrelationAttributeNormalizationException

Retrieves eamArtifact instances from the database that are associated with the eamArtifactType and eamArtifactValue of the given eamArtifact.

Parameters
aTypeThe type of the artifact
valueThe correlation value
Returns
List of artifact instances for a given type/value
Exceptions
CorrelationAttributeNormalizationException
CentralRepoException

Referenced by org.sleuthkit.autopsy.centralrepository.contentviewer.DataContentViewerOtherCases.getCorrelatedInstances(), org.sleuthkit.autopsy.contentviewers.AnnotationsContentViewer.getCorrelationAttributeComments(), and org.sleuthkit.autopsy.centralrepository.eventlisteners.IngestEventsListener.DataAddedTask.run().

List<CorrelationAttributeInstance> org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getArtifactInstancesByTypeValues ( CorrelationAttributeInstance.Type  aType,
List< String >  values 
) throws CentralRepoException, CorrelationAttributeNormalizationException

Retrieves eamArtifact instances from the database that are associated with the eamArtifactType and eamArtifactValues of the given eamArtifact.

Parameters
aTypeEamArtifact.Type to search for
valuesThe list of correlation values to get CorrelationAttributeInstances for
Returns
List of artifact instances for a given type with the specified values
Exceptions
CorrelationAttributeNormalizationException
CentralRepoException

Referenced by org.sleuthkit.autopsy.commonpropertiessearch.InterCaseSearchResultsProcessor.InterCaseByCountCallback.process(), and org.sleuthkit.autopsy.commonpropertiessearch.InterCaseSearchResultsProcessor.InterCaseByCaseCallback.process().

List<CorrelationAttributeInstance> org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getArtifactInstancesByTypeValuesAndCases ( CorrelationAttributeInstance.Type  aType,
List< String >  values,
List< Integer >  caseIds 
) throws CentralRepoException, CorrelationAttributeNormalizationException

Retrieves eamArtifact instances from the database that are associated with the eamArtifactType and eamArtifactValues of the given eamArtifact for the specified cases.

Parameters
aTypeThe type of the artifact
valuesThe list of correlation values to get CorrelationAttributeInstances for
caseIdsThe list of central repository case ids to get CorrelationAttributeInstances for
Returns
List of artifact instances for a given type with the specified values for the specified cases
Exceptions
CorrelationAttributeNormalizationException
CentralRepoException

Referenced by org.sleuthkit.autopsy.commonpropertiessearch.InterCaseSearchResultsProcessor.InterCaseByCountCallback.process(), and org.sleuthkit.autopsy.commonpropertiessearch.InterCaseSearchResultsProcessor.InterCaseByCaseCallback.process().

CorrelationCase org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getCase ( Case  autopsyCase) throws CentralRepoException
CorrelationCase org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getCaseById ( int  caseId) throws CentralRepoException
CorrelationCase org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getCaseByUUID ( String  caseUUID) throws CentralRepoException

Retrieves Case details based on Case UUID

Parameters
caseUUIDunique identifier for a case
Returns
The retrieved case

Referenced by org.sleuthkit.autopsy.centralrepository.contentviewer.DataContentViewerOtherCases.getCaseCreatedDate(), and org.sleuthkit.autopsy.centralrepository.contentviewer.DataContentViewerOtherCases.showCaseDetails().

List<CorrelationCase> org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getCases ( ) throws CentralRepoException
CorrelationAttributeInstance org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getCorrelationAttributeInstance ( CorrelationAttributeInstance.Type  type,
CorrelationCase  correlationCase,
CorrelationDataSource  correlationDataSource,
String  value,
String  filePath 
) throws CentralRepoException, CorrelationAttributeNormalizationException

Find a correlation attribute in the Central Repository database given the instance type, case, data source, value, and file path.

Method exists to support instances added using Central Repository version 1,1 and older

Parameters
typeThe type of instance.
correlationCaseThe case tied to the instance.
correlationDataSourceThe data source tied to the instance.
valueThe value tied to the instance.
filePathThe file path tied to the instance.
Returns
The correlation attribute if it exists; otherwise null.
Exceptions
CentralRepoException

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeUtil.getCorrAttrForFile(), and org.sleuthkit.autopsy.commonpropertiessearch.InterCaseSearchResultsProcessor.InterCaseCommonAttributeRowCallback.process().

CorrelationAttributeInstance org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getCorrelationAttributeInstance ( CorrelationAttributeInstance.Type  type,
CorrelationCase  correlationCase,
CorrelationDataSource  correlationDataSource,
long  objectID 
) throws CentralRepoException, CorrelationAttributeNormalizationException

Find a correlation attribute in the Central Repository database given the instance type, case, data source, object id.

Parameters
typeThe type of instance.
correlationCaseThe case tied to the instance.
correlationDataSourceThe data source tied to the instance.
objectIDThe object id of the file tied to the instance.
Returns
The correlation attribute if it exists; otherwise null.
Exceptions
CentralRepoException
CorrelationAttributeInstance.Type org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getCorrelationTypeById ( int  typeId) throws CentralRepoException
Long org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getCountArtifactInstancesByCaseDataSource ( CorrelationDataSource  correlationDataSource) throws CentralRepoException

Retrieves number of eamArtifact instances in the database that are associated with the given data source.

Parameters
correlationDataSourceData source to search for
Returns
Number of artifact instances having caseDisplayName and dataSource
Long org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getCountArtifactInstancesByTypeValue ( CorrelationAttributeInstance.Type  aType,
String  value 
) throws CentralRepoException, CorrelationAttributeNormalizationException

Retrieves number of artifact instances in the database that are associated with the ArtifactType and artifactValue of the given artifact.

Parameters
aTypeEamArtifact.Type to search for
valueValue to search for
Returns
Number of artifact instances having ArtifactType and ArtifactValue.
Long org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getCountArtifactInstancesKnownBad ( CorrelationAttributeInstance.Type  aType,
String  value 
) throws CentralRepoException, CorrelationAttributeNormalizationException

Count matching eamArtifacts instances that have knownStatus = "Bad".

Parameters
aTypeEamArtifact.Type to search for
valueValue to search for
Returns
Number of matching eamArtifacts

Referenced by org.sleuthkit.autopsy.discovery.search.SearchFiltering.NotableFilter.applyAlternateFilter().

Long org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getCountUniqueCaseDataSourceTuplesHavingTypeValue ( CorrelationAttributeInstance.Type  aType,
String  value 
) throws CentralRepoException, CorrelationAttributeNormalizationException

Retrieves number of unique caseDisplayName / dataSource tuples in the database that are associated with the artifactType and artifactValue of the given artifact.

Parameters
aTypeEamArtifact.Type to search for
valueValue to search for
Returns
Number of unique tuples

Referenced by org.sleuthkit.autopsy.commonpropertiessearch.CommonAttributeCountSearchResults.filterMetadata(), org.sleuthkit.autopsy.commonpropertiessearch.CommonAttributeCaseSearchResults.filterValue(), org.sleuthkit.autopsy.datamodel.AbstractAbstractFileNode< SpecialDirectory >.getCountPropertyAndDescription(), and org.sleuthkit.autopsy.datamodel.BlackboardArtifactNode.getCountPropertyAndDescription().

Long org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getCountUniqueDataSources ( ) throws CentralRepoException
CorrelationDataSource org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getDataSource ( CorrelationCase  correlationCase,
Long  caseDbDataSourceId 
) throws CentralRepoException
CorrelationDataSource org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getDataSourceById ( CorrelationCase  correlationCase,
int  dataSourceId 
) throws CentralRepoException

Retrieves Data Source details based on data source ID

Parameters
correlationCasethe current CorrelationCase used for ensuring uniqueness of DataSource
dataSourceIdthe data source ID number
Returns
The data source

Referenced by org.sleuthkit.autopsy.commonpropertiessearch.InterCaseSearchResultsProcessor.InterCaseCommonAttributeRowCallback.process(), and org.sleuthkit.autopsy.centralrepository.datamodel.Persona.DatasourceForAccountInstanceQueryCallback.process().

List<CorrelationDataSource> org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getDataSources ( ) throws CentralRepoException

Retrieves data sources that are in DB

Returns
List of data sources

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepositoryService.dataUpgradeForVersion1dot2().

String org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getDbInfo ( String  name) throws CentralRepoException

Get the value for the given name from the name/value db_info table.

Parameters
nameName to search for
Returns
value associated with name.
Exceptions
CentralRepoException
List<CorrelationAttributeInstance.Type> org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getDefinedCorrelationTypes ( ) throws CentralRepoException
List<CorrelationAttributeInstance.Type> org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getEnabledCorrelationTypes ( ) throws CentralRepoException

Get the list of enabled EamArtifact.Type's that will be used to correlate artifacts.

Returns
List of enabled EamArtifact.Type's. If none are defined in the database, the default list will be returned.
Exceptions
CentralRepoException
CoordinationService.Lock org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getExclusiveMultiUserDbLock ( ) throws CentralRepoException

Gets an exclusive lock (if applicable). Will return the lock if successful, null if unsuccessful because locking isn't supported, and throw an exception if we should have been able to get the lock but failed (meaning the database is in use).

Returns
the lock, or null if locking is not supported
Exceptions
CentralRepoExceptionif the coordination service is running but we fail to get the lock
int org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getFrequencyPercentage ( CorrelationAttributeInstance  corAttr) throws CentralRepoException, CorrelationAttributeNormalizationException

Calculate the percentage of data sources that have this attribute value.

Parameters
corAttrAttribute type and value to get data about
Returns
Int between 0 and 100

Referenced by org.sleuthkit.autopsy.centralrepository.contentviewer.DataContentViewerOtherCases.showCommonalityDetails().

static CentralRepository org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getInstance ( ) throws CentralRepoException
static

Get the instance

Returns
The EamDb instance or null if one is not configured.
Exceptions
CentralRepoException

Definition at line 44 of file CentralRepository.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbUtil.allowUseOfCentralRepository(), org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPlatforms.DISABLED, org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbChoice.getDbPlatform(), and org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbManager.getSavedDbChoice().

Referenced by org.sleuthkit.autopsy.centralrepository.AddEditCentralRepoCommentAction.actionPerformed(), org.sleuthkit.autopsy.contentviewers.artifactviewers.PersonaAccountFetcher.CreatePersonaButtonListener.actionPerformed(), org.sleuthkit.autopsy.contentviewers.artifactviewers.MessageAccountPanel.PersonaButtonListener.actionPerformed(), org.sleuthkit.autopsy.modules.hashdatabase.HashLookupSettingsPanel.cancel(), org.sleuthkit.autopsy.centralrepository.persona.CreatePersonaAccountDialog.createAccount(), org.sleuthkit.autopsy.commonpropertiessearch.CommonAttributeSearchAction.createAndShowPanel(), org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepositoryService.dataUpgradeForVersion1dot2(), org.sleuthkit.autopsy.centralrepository.datamodel.Persona.delete(), org.sleuthkit.autopsy.centralrepository.optionspanel.ManageOrganizationsDialog.deleteButtonActionPerformed(), org.sleuthkit.autopsy.modules.hashdatabase.ImportCentralRepoDbProgressDialog.CentralRepoImportWorker.deleteIncompleteSet(), org.sleuthkit.autopsy.modules.hashdatabase.ImportCentralRepoDbProgressDialog.CentralRepoImportWorker.doInBackground(), org.sleuthkit.autopsy.contentviewers.artifactviewers.ContactArtifactViewer.ContactPersonaSearcherTask.doInBackground(), org.sleuthkit.autopsy.commonpropertiessearch.CommonAttributeCaseSearchResults.filterMetadata(), org.sleuthkit.autopsy.commonpropertiessearch.CommonAttributeCountSearchResults.filterMetadata(), org.sleuthkit.autopsy.commonpropertiessearch.CommonAttributeCaseSearchResults.filterValue(), org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationDataSource.fromTSKDataSource(), org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoAccount.getAccountsWithIdentifier(), org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoAccount.getAccountsWithIdentifierLike(), org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoAccount.getAllAccounts(), org.sleuthkit.autopsy.centralrepository.persona.CreatePersonaAccountDialog.getAllAccountTypes(), org.sleuthkit.autopsy.centralrepository.persona.PersonaAccountDialog.getAllAccountTypes(), org.sleuthkit.autopsy.centralrepository.contentviewer.DataContentViewerOtherCases.getCaseCreatedDate(), org.sleuthkit.autopsy.modules.hashdatabase.HashDbManager.getCentralRepoHashSetsFromDatabase(), org.sleuthkit.autopsy.contentviewers.AnnotationsContentViewer.getCentralRepositoryData(), org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeUtil.getCorrAttrForFile(), org.sleuthkit.autopsy.centralrepository.contentviewer.DataContentViewerOtherCases.getCorrelatedInstances(), org.sleuthkit.autopsy.contentviewers.AnnotationsContentViewer.getCorrelationAttributeComments(), org.sleuthkit.autopsy.centralrepository.contentviewer.DataContentViewerOtherCases.getCorrelationAttributesFromNode(), org.sleuthkit.autopsy.datamodel.AbstractAbstractFileNode< SpecialDirectory >.getCountPropertyAndDescription(), org.sleuthkit.autopsy.datamodel.BlackboardArtifactNode.getCountPropertyAndDescription(), org.sleuthkit.autopsy.centralrepository.datamodel.PersonaAlias.getCRInstance(), org.sleuthkit.autopsy.centralrepository.datamodel.PersonaMetadata.getCRInstance(), org.sleuthkit.autopsy.centralrepository.datamodel.PersonaAccount.getCRInstance(), org.sleuthkit.autopsy.centralrepository.datamodel.Persona.getCRInstance(), org.sleuthkit.autopsy.centralrepository.optionspanel.ManageOrganizationsDialog.init(), org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeUtil.makeCorrAttr(), org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeUtil.makeCorrAttrFromAcctArtifact(), org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeUtil.makeCorrAttrFromArtifactAttr(), org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeUtil.makeCorrAttrFromFile(), org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeUtil.makeCorrAttrsFromCommunicationArtifacts(), org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbManager.obtainCentralRepository(), org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbManager.onUpgradeError(), org.sleuthkit.autopsy.commonpropertiessearch.InterCaseSearchResultsProcessor.InterCaseByCountCallback.process(), org.sleuthkit.autopsy.commonpropertiessearch.InterCaseSearchResultsProcessor.InterCaseByCaseCallback.process(), org.sleuthkit.autopsy.commonpropertiessearch.InterCaseSearchResultsProcessor.InterCaseCommonAttributeRowCallback.process(), org.sleuthkit.autopsy.centralrepository.eventlisteners.CaseEventListener.propertyChange(), org.sleuthkit.autopsy.centralrepository.eventlisteners.IngestEventsListener.IngestModuleEventListener.propertyChange(), org.sleuthkit.autopsy.centralrepository.eventlisteners.IngestEventsListener.IngestJobEventListener.propertyChange(), org.sleuthkit.autopsy.centralrepository.eventlisteners.CaseEventListener.TagDefinitionChangeTask.run(), org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbManager.saveNewCentralRepo(), org.sleuthkit.autopsy.centralrepository.datamodel.Persona.setComment(), org.sleuthkit.autopsy.centralrepository.contentviewer.DataContentViewerOtherCases.setEarliestCaseDate(), org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationDataSource.setMd5(), org.sleuthkit.autopsy.centralrepository.datamodel.Persona.setName(), org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationDataSource.setSha1(), org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationDataSource.setSha256(), org.sleuthkit.autopsy.centralrepository.contentviewer.DataContentViewerOtherCases.showCaseDetails(), and org.sleuthkit.autopsy.centralrepository.contentviewer.DataContentViewerOtherCases.showCommonalityDetails().

List<String> org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getListCasesHavingArtifactInstances ( CorrelationAttributeInstance.Type  aType,
String  value 
) throws CentralRepoException, CorrelationAttributeNormalizationException

Gets list of distinct case display names, where each case has 1+ Artifact Instance matching eamArtifact.

Parameters
aTypeEamArtifact.Type to search for
valueValue to search for
Returns
List of cases containing this artifact with instances marked as bad
Exceptions
CentralRepoException

Referenced by org.sleuthkit.autopsy.centralrepository.eventlisteners.IngestEventsListener.DataAddedTask.run().

List<String> org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getListCasesHavingArtifactInstancesKnownBad ( CorrelationAttributeInstance.Type  aType,
String  value 
) throws CentralRepoException, CorrelationAttributeNormalizationException

Gets list of distinct case display names, where each case has 1+ Artifact Instance matching eamArtifact with knownStatus = "Bad".

Parameters
aTypeEamArtifact.Type to search for
valueValue to search for
Returns
List of cases containing this artifact with instances marked as bad
Exceptions
CentralRepoException

Referenced by org.sleuthkit.autopsy.centralrepository.eventlisteners.IngestEventsListener.DataAddedTask.run().

CentralRepoAccount org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getOrCreateAccount ( CentralRepoAccount.CentralRepoAccountType  crAccountType,
String  accountUniqueID 
) throws InvalidAccountIDException, CentralRepoException

Get an account from the accounts table matching the given type/ID. Inserts a row if one doesn't exists.

Parameters
crAccountTypeCR account type to look for or create
accountUniqueIDtype specific unique account id
Returns
CR account
Exceptions
CentralRepoExceptionIf there is an error accessing Central Repository.
InvalidAccountIDExceptionIf the account identifier is not valid.

Referenced by org.sleuthkit.autopsy.centralrepository.persona.CreatePersonaAccountDialog.createAccount(), and org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeUtil.makeCorrAttrFromAcctArtifact().

CentralRepoOrganization org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getOrganizationByID ( int  orgID) throws CentralRepoException

Get an organization having the given ID

Parameters
orgIDThe id to look up
Returns
The organization with the given ID
Exceptions
CentralRepoException
List<CentralRepoOrganization> org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getOrganizations ( ) throws CentralRepoException

Get all organizations

Returns
A list of all organizations
Exceptions
CentralRepoException

Referenced by org.sleuthkit.autopsy.centralrepository.optionspanel.ManageOrganizationsDialog.populateListAndSelect().

CentralRepoExaminer org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getOrInsertExaminer ( String  examinerLoginName) throws CentralRepoException

Queries the examiner table for the given user name. Adds a row if the user is not found in the examiner table.

Parameters
examinerLoginNameuser name to look for.
Returns
CentralRepoExaminer for the given user name.
Exceptions
CentralRepoExceptionIf there is an error in looking up or inserting the user in the examiners table.

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

List<CentralRepoFileInstance> org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getReferenceInstancesByTypeValue ( CorrelationAttributeInstance.Type  aType,
String  aValue 
) throws CentralRepoException, CorrelationAttributeNormalizationException

Get all reference entries having a given correlation type and value

Parameters
aTypeType to use for matching
aValueValue to use for matching
Returns
List of all global file instances with a type and value
Exceptions
CentralRepoException
CentralRepoFileSet org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getReferenceSetByID ( int  globalSetID) throws CentralRepoException

Get a global set by ID

Parameters
globalSetIDThe ID to look up
Returns
The global set associated with the ID
Exceptions
CentralRepoException
CentralRepoOrganization org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getReferenceSetOrganization ( int  referenceSetID) throws CentralRepoException

Get the organization associated with the given reference set.

Parameters
referenceSetIDID of the reference set
Returns
The organization object
Exceptions
CentralRepoException
List<CorrelationAttributeInstance.Type> org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.getSupportedCorrelationTypes ( ) throws CentralRepoException

Get the list of supported EamArtifact.Type's that can be used to correlate artifacts.

Returns
List of supported EamArtifact.Type's. If none are defined in the database, the default list will be returned.
Exceptions
CentralRepoException
boolean org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.isArtifactKnownBadByReference ( CorrelationAttributeInstance.Type  aType,
String  value 
) throws CentralRepoException, CorrelationAttributeNormalizationException

Is the artifact known as bad according to the reference entries?

Parameters
aTypeEamArtifact.Type to search for
valueValue to search for
Returns
Global known status of the artifact
static boolean org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.isEnabled ( )
static

Is the database enabled?

Returns
Is the database enabled

Definition at line 98 of file CentralRepository.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbUtil.allowUseOfCentralRepository(), org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbChoice.DISABLED, and org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbManager.getSavedDbChoice().

Referenced by org.sleuthkit.autopsy.modules.hashdatabase.HashLookupSettingsPanel.cancel(), org.sleuthkit.autopsy.modules.hashdatabase.HashDbManager.configureLocalDb(), org.sleuthkit.autopsy.modules.hashdatabase.HashDbManager.configureSettings(), org.sleuthkit.autopsy.commonpropertiessearch.CommonAttributeSearchAction.createAndShowPanel(), org.sleuthkit.autopsy.datamodel.BlackboardArtifactNode.createSheet(), org.sleuthkit.autopsy.communications.CVTPersonaCache.CVTPersonaCache(), org.sleuthkit.autopsy.discovery.ui.DomainFilterPanel.DomainFilterPanel(), org.sleuthkit.autopsy.centralrepository.persona.PersonasTopComponent.executeSearch(), org.sleuthkit.autopsy.commonpropertiessearch.CommonAttributeCountSearchResults.filterMetadata(), org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationDataSource.fromTSKDataSource(), org.sleuthkit.autopsy.centralrepository.CentralRepoContextMenuActionsProvider.getActions(), org.sleuthkit.autopsy.centralrepository.contentviewer.DataContentViewerOtherCases.getCaseCreatedDate(), org.sleuthkit.autopsy.modules.hashdatabase.HashDbManager.getCentralRepoHashSetsFromDatabase(), org.sleuthkit.autopsy.centralrepository.contentviewer.DataContentViewerOtherCases.getCorrelatedInstances(), org.sleuthkit.autopsy.datamodel.AbstractAbstractFileNode< SpecialDirectory >.getCorrelationAttributeInstance(), org.sleuthkit.autopsy.datamodel.BlackboardArtifactNode.getCorrelationAttributeInstance(), org.sleuthkit.autopsy.centralrepository.contentviewer.DataContentViewerOtherCases.getCorrelationAttributesFromNode(), org.sleuthkit.autopsy.discovery.search.DiscoveryAttributes.GroupingAttributeType.getOptionsForGroupingForDomains(), org.sleuthkit.autopsy.datamodel.AbstractAbstractFileNode< SpecialDirectory >.getProperties(), org.sleuthkit.autopsy.contentviewers.artifactviewers.ContactArtifactViewer.initiatePersonasSearch(), org.sleuthkit.autopsy.allcasessearch.AllCasesSearchAction.isEnabled(), org.sleuthkit.autopsy.centralrepository.persona.OpenPersonasAction.isEnabled(), org.sleuthkit.autopsy.centralrepository.contentviewer.DataContentViewerOtherCases.isSupported(), org.sleuthkit.autopsy.contentviewers.artifactviewers.MessageArtifactViewer.MessageArtifactViewer(), org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepositoryService.openCaseResources(), org.sleuthkit.autopsy.centralrepository.persona.OpenPersonasAction.OpenPersonasAction(), org.sleuthkit.autopsy.contentviewers.AnnotationsContentViewer.renderArtifact(), org.sleuthkit.autopsy.contentviewers.AnnotationsContentViewer.renderContent(), org.sleuthkit.autopsy.centralrepository.contentviewer.DataContentViewerOtherCases.rightClickPopupMenuPopupMenuWillBecomeVisible(), org.sleuthkit.autopsy.centralrepository.eventlisteners.CaseEventListener.ContentTagTask.run(), org.sleuthkit.autopsy.centralrepository.eventlisteners.CaseEventListener.BlackboardTagTask.run(), org.sleuthkit.autopsy.centralrepository.eventlisteners.IngestEventsListener.AnalysisCompleteTask.run(), org.sleuthkit.autopsy.centralrepository.eventlisteners.IngestEventsListener.DataAddedTask.run(), org.sleuthkit.autopsy.centralrepository.eventlisteners.CaseEventListener.TagDefinitionChangeTask.run(), org.sleuthkit.autopsy.centralrepository.eventlisteners.CaseEventListener.DataSourceAddedTask.run(), org.sleuthkit.autopsy.centralrepository.eventlisteners.CaseEventListener.CurrentCaseTask.run(), org.sleuthkit.autopsy.centralrepository.eventlisteners.CaseEventListener.DataSourceNameChangedTask.run(), org.sleuthkit.autopsy.centralrepository.contentviewer.DataContentViewerOtherCases.setEarliestCaseDate(), org.sleuthkit.autopsy.communications.relationships.SummaryViewer.setSelectionInfo(), org.sleuthkit.autopsy.modules.hashdatabase.HashDbManager.updateHashSetsFromCentralRepository(), org.sleuthkit.autopsy.communications.relationships.SummaryViewer.updateOtherAccountInfo(), org.sleuthkit.autopsy.contentviewers.artifactviewers.CallLogArtifactViewer.updateView(), and org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbManager.upgradeDatabase().

boolean org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.isFileHashInReferenceSet ( String  hash,
int  referenceSetID 
) throws CentralRepoException, CorrelationAttributeNormalizationException

Check if the given file hash is in this reference set. Only searches the reference_files table.

Parameters
hash
referenceSetID
Returns
true if the hash is found in the reference set
Exceptions
CentralRepoException
boolean org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.isValueInReferenceSet ( String  value,
int  referenceSetID,
int  correlationTypeID 
) throws CentralRepoException, CorrelationAttributeNormalizationException

Check if the given value is in a specific reference set

Parameters
value
referenceSetID
correlationTypeID
Returns
true if the hash is found in the reference set
HashHitInfo org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.lookupHash ( String  hash,
int  referenceSetID 
) throws CentralRepoException, CorrelationAttributeNormalizationException

Retrieves the given file HashHitInfo if the given file hash is in this reference set. Only searches the reference_files table.

Parameters
hashThe hash to find in a search.
referenceSetIDThe referenceSetID within which the file should exist.
Returns
The HashHitInfo if found or null if not found.
Exceptions
CentralRepoException
CorrelationAttributeNormalizationException
CorrelationCase org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.newCase ( CorrelationCase  eamCase) throws CentralRepoException

Creates new Case in the database

Expects the Organization for this case to already exist in the database.

Parameters
eamCaseThe case to add

Referenced by org.sleuthkit.autopsy.centralrepository.eventlisteners.IngestEventsListener.AnalysisCompleteTask.run(), and org.sleuthkit.autopsy.centralrepository.eventlisteners.CaseEventListener.CurrentCaseTask.run().

CorrelationCase org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.newCase ( Case  autopsyCase) throws CentralRepoException

Creates new Case in the database from the given case

Parameters
autopsyCaseThe case to add
int org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.newCorrelationType ( CorrelationAttributeInstance.Type  newType) throws CentralRepoException

Add a new EamArtifact.Type to the db.

Parameters
newTypeNew type to add.
Returns
Type.ID for newType
Exceptions
CentralRepoException
CorrelationDataSource org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.newDataSource ( CorrelationDataSource  eamDataSource) throws CentralRepoException

Creates new Data Source in the database

Parameters
eamDataSourcethe data source to add
Returns
- A CorrelationDataSource object with data source's central repository id

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationDataSource.fromTSKDataSource().

void org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.newDbInfo ( String  name,
String  value 
) throws CentralRepoException

Add a new name/value pair in the db_info table.

Parameters
nameKey to set
valueValue to set
Exceptions
CentralRepoException
CentralRepoOrganization org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.newOrganization ( CentralRepoOrganization  eamOrg) throws CentralRepoException

Add a new organization

Parameters
eamOrgThe organization to add
Returns
The organization with the org ID set.
Exceptions
CentralRepoException
int org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.newReferenceSet ( CentralRepoFileSet  eamGlobalSet) throws CentralRepoException

Add a new Global Set

Parameters
eamGlobalSetThe global set to add
Returns
The ID of the new global set
Exceptions
CentralRepoException

Referenced by org.sleuthkit.autopsy.modules.hashdatabase.ImportCentralRepoDbProgressDialog.CentralRepoImportWorker.doInBackground().

void org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.processInstanceTable ( CorrelationAttributeInstance.Type  type,
InstanceTableCallback  instanceTableCallback 
) throws CentralRepoException

Process the Artifact instance in the EamDb

Parameters
typeEamArtifact.Type to search for
instanceTableCallbackcallback to process the instance
Exceptions
CentralRepoException
void org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.processInstanceTableWhere ( CorrelationAttributeInstance.Type  type,
String  whereClause,
InstanceTableCallback  instanceTableCallback 
) throws CentralRepoException

Process the Artifact instance in the EamDb

Parameters
typeEamArtifact.Type to search for
instanceTableCallbackcallback to process the instance
whereClausequery string to execute
Exceptions
CentralRepoException
void org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.processSelectClause ( String  selectClause,
InstanceTableCallback  instanceTableCallback 
) throws CentralRepoException

Process a SELECT query

Parameters
selectClausequery string to execute
instanceTableCallbackcallback to process the instance
Exceptions
CentralRepoException

Referenced by org.sleuthkit.autopsy.discovery.search.DiscoveryAttributes.computeFrequency().

boolean org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.referenceSetExists ( String  referenceSetName,
String  version 
) throws CentralRepoException

Check whether a reference set with the given name/version is in the central repo. Used to check for name collisions when creating reference sets.

Parameters
referenceSetName
version
Returns
true if a matching set is found
Exceptions
CentralRepoException
boolean org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.referenceSetIsValid ( int  referenceSetID,
String  referenceSetName,
String  version 
) throws CentralRepoException

Check whether a reference set with the given parameters exists in the central repository. Used to check whether reference sets saved in the settings are still present.

Parameters
referenceSetID
referenceSetName
version
Returns
true if a matching entry exists in the central repository
Exceptions
CentralRepoException
void org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.reset ( ) throws CentralRepoException

Reset the database (testing method)

void org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.saveSettings ( )

Save settings

void org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.setAttributeInstanceKnownStatus ( CorrelationAttributeInstance  eamArtifact,
TskData.FileKnown  knownStatus 
) throws CentralRepoException

Sets an eamArtifact instance to the given known status. If eamArtifact exists, it is updated. If eamArtifact does not exist nothing happens

Parameters
eamArtifactArtifact containing exactly one (1) ArtifactInstance.
knownStatusThe status to change the artifact to

Referenced by org.sleuthkit.autopsy.centralrepository.eventlisteners.CaseEventListener.TagDefinitionChangeTask.run(), org.sleuthkit.autopsy.centralrepository.eventlisteners.CaseEventListener.BlackboardTagTask.setArtifactKnownStatus(), and org.sleuthkit.autopsy.centralrepository.eventlisteners.CaseEventListener.ContentTagTask.setContentKnownStatus().

void org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.shutdownConnections ( ) throws CentralRepoException

Shutdown the connection pool.

This closes the connection pool including all idle database connections. It will not close active/in-use connections. Thus, it is vital that there are no in-use connections when you call this method.

Exceptions
CentralRepoExceptionif there is a problem closing the connection pool.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbManager.onUpgradeError(), and org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbManager.saveNewCentralRepo().

void org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.updateAttributeInstanceComment ( CorrelationAttributeInstance  eamArtifact) throws CentralRepoException

Update a correlation attribute instance comment in the database with that in the associated CorrelationAttribute object.

Parameters
eamArtifactThe correlation attribute whose database instance will be updated.
Exceptions
CentralRepoException

Referenced by org.sleuthkit.autopsy.centralrepository.AddEditCentralRepoCommentAction.actionPerformed().

void org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.updateCase ( CorrelationCase  eamCase) throws CentralRepoException

Updates an existing Case in the database

Parameters
eamCaseThe case to update
void org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.updateCorrelationType ( CorrelationAttributeInstance.Type  aType) throws CentralRepoException

Update a EamArtifact.Type.

Parameters
aTypeEamArtifact.Type to update.
Exceptions
CentralRepoException
void org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.updateDataSourceMd5Hash ( CorrelationDataSource  eamDataSource) throws CentralRepoException

Updates the MD5 hash value in an existing data source in the database.

Parameters
eamDataSourceThe data source to update

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationDataSource.setMd5().

void org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.updateDataSourceName ( CorrelationDataSource  eamDataSource,
String  newName 
) throws CentralRepoException

Changes the name of a data source in the DB

Parameters
eamDataSourceThe data source
newNameThe new name
Exceptions
CentralRepoException

Referenced by org.sleuthkit.autopsy.centralrepository.eventlisteners.CaseEventListener.DataSourceNameChangedTask.run().

void org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.updateDataSourceSha1Hash ( CorrelationDataSource  eamDataSource) throws CentralRepoException

Updates the SHA-1 hash value in an existing data source in the database.

Parameters
eamDataSourceThe data source to update

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationDataSource.setSha1().

void org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.updateDataSourceSha256Hash ( CorrelationDataSource  eamDataSource) throws CentralRepoException

Updates the SHA-256 hash value in an existing data source in the database.

Parameters
eamDataSourceThe data source to update

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationDataSource.setSha256().

void org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.updateDbInfo ( String  name,
String  value 
) throws CentralRepoException

Update the value for a name in the name/value db_info table.

Parameters
nameName to find
valueValue to assign to name.
Exceptions
CentralRepoException
void org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.updateOrganization ( CentralRepoOrganization  updatedOrganization) throws CentralRepoException

Update an existing organization.

Parameters
updatedOrganizationthe values the Organization with the same ID will be updated to in the database.
Exceptions
CentralRepoException
void org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.updateSettings ( )

Update settings

When using updateSettings, if any database settings have changed, you should call shutdownConnections() before using any API methods. That will ensure that any old connections are closed and all new connections will be made using the new settings.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbManager.saveNewCentralRepo().

void org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository.upgradeSchema ( ) throws CentralRepoException, SQLException, IncompatibleCentralRepoException

Upgrade the schema of the database (if needed)

Exceptions
CentralRepoException

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbManager.updatedDbSchema().


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

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