org.sleuthkit.autopsy.centralrepository.datamodel.EamDb Interface Reference

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

Public Member Functions
void	addArtifact (CorrelationAttribute eamArtifact) throws EamDbException
void	addReferenceInstance (EamGlobalFileInstance eamGlobalFileInstance, CorrelationAttribute.Type correlationType) throws EamDbException
void	bulkInsertArtifacts () throws EamDbException
void	bulkInsertCases (List< CorrelationCase > cases) throws EamDbException
void	bulkInsertReferenceTypeEntries (Set< EamGlobalFileInstance > globalInstances, CorrelationAttribute.Type contentType) throws EamDbException
List< CorrelationAttributeInstance >	getArtifactInstancesByPath (CorrelationAttribute.Type aType, String filePath) throws EamDbException
List< CorrelationAttributeInstance >	getArtifactInstancesByTypeValue (CorrelationAttribute.Type aType, String value) throws EamDbException
List< CorrelationAttributeInstance >	getArtifactInstancesKnownBad (CorrelationAttribute.Type aType, String value) throws EamDbException
List< String >	getBadTags ()
CorrelationCase	getCaseByUUID (String caseUUID) throws EamDbException
List< CorrelationCase >	getCases () throws EamDbException
CorrelationAttribute.Type	getCorrelationTypeById (int typeId) throws EamDbException
Long	getCountArtifactInstancesByCaseDataSource (String caseUUID, String dataSourceID) throws EamDbException
Long	getCountArtifactInstancesByTypeValue (CorrelationAttribute.Type aType, String value) throws EamDbException
Long	getCountArtifactInstancesKnownBad (CorrelationAttribute.Type aType, String value) throws EamDbException
Long	getCountUniqueCaseDataSourceTuplesHavingTypeValue (CorrelationAttribute.Type aType, String value) throws EamDbException
Long	getCountUniqueDataSources () throws EamDbException
CorrelationDataSource	getDataSourceDetails (String dataSourceDeviceId) throws EamDbException
List< CorrelationDataSource >	getDataSources () throws EamDbException
String	getDbInfo (String name) throws EamDbException
List< CorrelationAttribute.Type >	getDefinedCorrelationTypes () throws EamDbException
List< CorrelationAttribute.Type >	getEnabledCorrelationTypes () throws EamDbException
int	getFrequencyPercentage (CorrelationAttribute corAttr) throws EamDbException
List< String >	getListCasesHavingArtifactInstancesKnownBad (CorrelationAttribute.Type aType, String value) throws EamDbException
EamOrganization	getOrganizationByID (int orgID) throws EamDbException
List< EamOrganization >	getOrganizations () throws EamDbException
List< EamGlobalFileInstance >	getReferenceInstancesByTypeValue (CorrelationAttribute.Type aType, String aValue) throws EamDbException
EamGlobalSet	getReferenceSetByID (int globalSetID) throws EamDbException
List< CorrelationAttribute.Type >	getSupportedCorrelationTypes () throws EamDbException
boolean	isArtifactlKnownBadByReference (CorrelationAttribute.Type aType, String value) throws EamDbException
void	newCase (CorrelationCase eamCase) throws EamDbException
CorrelationCase	newCase (Case autopsyCase) throws EamDbException
int	newCorrelationType (CorrelationAttribute.Type newType) throws EamDbException
void	newDataSource (CorrelationDataSource eamDataSource) throws EamDbException
void	newDbInfo (String name, String value) throws EamDbException
void	newOrganization (EamOrganization eamOrg) throws EamDbException
int	newReferencelSet (EamGlobalSet eamGlobalSet) throws EamDbException
void	prepareBulkArtifact (CorrelationAttribute eamArtifact) throws EamDbException
void	reset () throws EamDbException
void	saveSettings ()
void	setArtifactInstanceKnownStatus (CorrelationAttribute eamArtifact, TskData.FileKnown knownStatus) throws EamDbException
void	setBadTags (List< String > tags)
void	shutdownConnections () throws EamDbException
void	updateCase (CorrelationCase eamCase) throws EamDbException
void	updateCorrelationType (CorrelationAttribute.Type aType) throws EamDbException
void	updateDbInfo (String name, String value) throws EamDbException
void	updateSettings ()

Static Public Member Functions
static EamDb	getInstance () throws EamDbException
static boolean	isEnabled ()

Static Public Attributes
static final int	SCHEMA_VERSION = 1

Detailed Description

Main interface for interacting with the database

Definition at line 29 of file EamDb.java.

Member Function Documentation

void org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.addArtifact

(

CorrelationAttribute

eamArtifact

)

throws EamDbException

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

Parameters

eamArtifact

The artifact to add

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb.

Referenced by org.sleuthkit.autopsy.centralrepository.eventlisteners.NewArtifactsRunner.run().

void org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.addReferenceInstance	(	EamGlobalFileInstance	eamGlobalFileInstance,
		CorrelationAttribute.Type	correlationType
	)		throws EamDbException

Add a new reference instance

Parameters

eamGlobalFileInstance	The reference instance to add
correlationType	Correlation Type that this Reference Instance is

Exceptions

EamDbException

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb.

void org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.bulkInsertArtifacts

(

)

throws EamDbException

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

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb.

void org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.bulkInsertCases

(

List< CorrelationCase >

cases

)

throws EamDbException

Executes a bulk insert of the cases

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb.

void org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.bulkInsertReferenceTypeEntries	(	Set< EamGlobalFileInstance >	globalInstances,
		CorrelationAttribute.Type	contentType
	)		throws EamDbException

Add a new global file instance to the bulk collection

Parameters

eamGlobalFileInstance

The global file instance to add

Exceptions

EamDbException

Insert the bulk collection of Global File Instances

Parameters

globalInstances	a Set of EamGlobalFileInstances to insert into the db.
contentType	the Type of the global instances

Exceptions

EamDbException

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb.

Referenced by org.sleuthkit.autopsy.centralrepository.optionspanel.ImportHashDatabaseDialog.ImportHashDatabaseWorker.importHashDatabase().

List<CorrelationAttributeInstance> org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.getArtifactInstancesByPath	(	CorrelationAttribute.Type	aType,
		String	filePath
	)		throws EamDbException

Retrieves eamArtifact instances from the database that are associated with the aType and filePath

Parameters

aType	EamArtifact.Type to search for
filePath	File path to search for

Returns

List of 0 or more EamArtifactInstances

Exceptions

EamDbException

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb.

List<CorrelationAttributeInstance> org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.getArtifactInstancesByTypeValue	(	CorrelationAttribute.Type	aType,
		String	value
	)		throws EamDbException

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

Parameters

aType	EamArtifact.Type to search for
value	Value to search for

Returns

List of artifact instances for a given type/value

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb.

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

List<CorrelationAttributeInstance> org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.getArtifactInstancesKnownBad	(	CorrelationAttribute.Type	aType,
		String	value
	)		throws EamDbException

Gets list of matching eamArtifact instances that have knownStatus = "Bad".

Parameters

aType	EamArtifact.Type to search for
value	Value to search for

Returns

List with 0 or more matching eamArtifact instances.

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb.

List<String> org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.getBadTags

(

)

Get the list of tags recognized as "Bad"

Returns

The list of bad tags

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb, org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb.

Referenced by org.sleuthkit.autopsy.centralrepository.eventlisteners.CaseEventListener.propertyChange().

CorrelationCase org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.getCaseByUUID

(

String

caseUUID

)

throws EamDbException

Retrieves Case details based on Case UUID

Parameters

caseUUID

unique identifier for a case

Returns

The retrieved case

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb.

Referenced by org.sleuthkit.autopsy.centralrepository.actions.EamCaseEditDetailsDialog.EamCaseEditDetailsDialog(), org.sleuthkit.autopsy.centralrepository.eventlisteners.CaseEventListener.propertyChange(), and org.sleuthkit.autopsy.centralrepository.contentviewer.DataContentViewerOtherCases.showCaseDetails().

List<CorrelationCase> org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.getCases

(

)

throws EamDbException

Retrieves cases that are in DB.

Returns

List of cases

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb.

CorrelationAttribute.Type org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.getCorrelationTypeById

(

int

typeId

)

throws EamDbException

Get the EamArtifact.Type that has the given Type.Id.

Parameters

typeId

Type.Id of Correlation Type to get

Returns

EamArtifact.Type or null if it doesn't exist.

Exceptions

EamDbException

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.EamArtifactUtil.getEamArtifactFromContent().

Long org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.getCountArtifactInstancesByCaseDataSource	(	String	caseUUID,
		String	dataSourceID
	)		throws EamDbException

Retrieves number of eamArtifact instances in the database that are associated with the caseDisplayName and dataSource of the given eamArtifact instance.

Parameters

caseUUID	Case ID to search for
dataSourceID	Data source ID to search for

Returns

Number of artifact instances having caseDisplayName and dataSource

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb.

Long org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.getCountArtifactInstancesByTypeValue	(	CorrelationAttribute.Type	aType,
		String	value
	)		throws EamDbException

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

Parameters

aType	EamArtifact.Type to search for
value	Value to search for

Returns

Number of artifact instances having ArtifactType and ArtifactValue.

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb.

Long org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.getCountArtifactInstancesKnownBad	(	CorrelationAttribute.Type	aType,
		String	value
	)		throws EamDbException

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

Parameters

aType	EamArtifact.Type to search for
value	Value to search for

Returns

Number of matching eamArtifacts

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb.

Long org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.getCountUniqueCaseDataSourceTuplesHavingTypeValue	(	CorrelationAttribute.Type	aType,
		String	value
	)		throws EamDbException

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

Parameters

aType	EamArtifact.Type to search for
value	Value to search for

Returns

Number of unique tuples

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb.

Long org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.getCountUniqueDataSources

(

)

throws EamDbException

Retrieves number of data sources in the database.

Returns

Number of unique data sources

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb.

CorrelationDataSource org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.getDataSourceDetails

(

String

dataSourceDeviceId

)

throws EamDbException

Updates a Data Source in the database

Parameters

eamDataSource	the data source to update Retrieves Data Source details based on data source device ID
dataSourceDeviceId	the data source device ID number

Returns

The data source

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb.

Referenced by org.sleuthkit.autopsy.centralrepository.eventlisteners.CaseEventListener.propertyChange().

List<CorrelationDataSource> org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.getDataSources

(

)

throws EamDbException

Retrieves data sources that are in DB

Returns

List of data sources

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb.

String org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.getDbInfo

(

String

name

)

throws EamDbException

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

Parameters

name	Name to search for

Returns

value associated with name.

Exceptions

EamDbException

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb.

List<CorrelationAttribute.Type> org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.getDefinedCorrelationTypes

(

)

throws EamDbException

Get the list of EamArtifact.Type's that are defined in the DB and can be used to correlate artifacts.

Returns

List of EamArtifact.Type's. If none are defined in the database, the default list will be returned.

Exceptions

EamDbException

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.EamArtifactUtil.getCorrelationAttributeFromBlackboardArtifact(), and org.sleuthkit.autopsy.centralrepository.contentviewer.DataContentViewerOtherCases.getCorrelationAttributesFromNode().

List<CorrelationAttribute.Type> org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.getEnabledCorrelationTypes

(

)

throws EamDbException

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

EamDbException

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb.

int org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.getFrequencyPercentage

(

CorrelationAttribute

corAttr

)

throws EamDbException

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

Parameters

corAttr

Attribute type and value to get data about

Returns

Int between 0 and 100

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb.

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

static EamDb org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.getInstance ( ) throws EamDbException

static

Get the instance

Returns

The EamDb instance or null if one is not configured.

Exceptions

EamDbException

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDb.

Definition at line 40 of file EamDb.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.EamDbPlatformEnum.DISABLED, org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDb.getInstance(), org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb.getInstance(), org.sleuthkit.autopsy.centralrepository.datamodel.EamDbPlatformEnum.getSelectedPlatform(), and org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.useCentralRepo().

Referenced by org.sleuthkit.autopsy.centralrepository.optionspanel.AddNewOrganizationDialog.bnOKActionPerformed(), org.sleuthkit.autopsy.centralrepository.optionspanel.EamDbSettingsDialog.bnOkActionPerformed(), org.sleuthkit.autopsy.centralrepository.actions.EamCaseEditDetailsDialog.EamCaseEditDetailsDialog(), org.sleuthkit.autopsy.centralrepository.contentviewer.DataContentViewerOtherCases.getCorrelatedInstances(), org.sleuthkit.autopsy.centralrepository.datamodel.EamArtifactUtil.getCorrelationAttributeFromBlackboardArtifact(), org.sleuthkit.autopsy.centralrepository.contentviewer.DataContentViewerOtherCases.getCorrelationAttributesFromNode(), org.sleuthkit.autopsy.centralrepository.datamodel.EamArtifactUtil.getEamArtifactFromContent(), org.sleuthkit.autopsy.centralrepository.contentviewer.DataContentViewerOtherCases.getReferenceInstancesAsArtifactInstances(), org.sleuthkit.autopsy.centralrepository.optionspanel.ImportHashDatabaseDialog.ImportHashDatabaseWorker.importHashDatabase(), org.sleuthkit.autopsy.centralrepository.eventlisteners.CaseEventListener.propertyChange(), org.sleuthkit.autopsy.centralrepository.eventlisteners.IngestEventsListener.IngestModuleEventListener.propertyChange(), org.sleuthkit.autopsy.centralrepository.eventlisteners.KnownStatusChangeRunner.run(), org.sleuthkit.autopsy.centralrepository.eventlisteners.NewArtifactsRunner.run(), org.sleuthkit.autopsy.centralrepository.contentviewer.DataContentViewerOtherCases.showCaseDetails(), and org.sleuthkit.autopsy.centralrepository.contentviewer.DataContentViewerOtherCases.showCommonalityDetails().

List<String> org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.getListCasesHavingArtifactInstancesKnownBad	(	CorrelationAttribute.Type	aType,
		String	value
	)		throws EamDbException

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

Parameters

aType	EamArtifact.Type to search for
value	Value to search for

Returns

List of cases containing this artifact with instances marked as bad

Exceptions

EamDbException

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb.

Referenced by org.sleuthkit.autopsy.centralrepository.eventlisteners.IngestEventsListener.IngestModuleEventListener.propertyChange().

EamOrganization org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.getOrganizationByID

(

int

orgID

)

throws EamDbException

Get an organization having the given ID

Parameters

orgID

The id to look up

Returns

The organization with the given ID

Exceptions

EamDbException

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb.

List<EamOrganization> org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.getOrganizations

(

)

throws EamDbException

Get all organizations

Returns

A list of all organizations

Exceptions

EamDbException

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb.

Referenced by org.sleuthkit.autopsy.centralrepository.actions.EamCaseEditDetailsDialog.loadOrganizationData().

List<EamGlobalFileInstance> org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.getReferenceInstancesByTypeValue	(	CorrelationAttribute.Type	aType,
		String	aValue
	)		throws EamDbException

Get all reference entries having a given correlation type and value

Parameters

aType	Type to use for matching
aValue	Value to use for matching

Returns

List of all global file instances with a type and value

Exceptions

EamDbException

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb.

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

EamGlobalSet org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.getReferenceSetByID

(

int

globalSetID

)

throws EamDbException

Get a global set by ID

Parameters

globalSetID

The ID to look up

Returns

The global set associated with the ID

Exceptions

EamDbException

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb.

List<CorrelationAttribute.Type> org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.getSupportedCorrelationTypes

(

)

throws EamDbException

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

EamDbException

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb.

boolean org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.isArtifactlKnownBadByReference	(	CorrelationAttribute.Type	aType,
		String	value
	)		throws EamDbException

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

Parameters

aType	EamArtifact.Type to search for
value	Value to search for

Returns

Global known status of the artifact

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb.

static boolean org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.isEnabled ( )

static

Is the database enabled?

Returns

Is the database enabled

Definition at line 93 of file EamDb.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.EamDbPlatformEnum.DISABLED, org.sleuthkit.autopsy.centralrepository.datamodel.EamDbPlatformEnum.getSelectedPlatform(), and org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.useCentralRepo().

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDb.connect(), org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb.connect(), org.sleuthkit.autopsy.centralrepository.optionspanel.ImportHashDatabaseDialog.ImportHashDatabaseWorker.ImportHashDatabaseWorker(), org.sleuthkit.autopsy.centralrepository.actions.EamEditCaseInfoAction.isEnabled(), org.sleuthkit.autopsy.centralrepository.contentviewer.DataContentViewerOtherCases.isSupported(), org.sleuthkit.autopsy.centralrepository.eventlisteners.CaseEventListener.propertyChange(), org.sleuthkit.autopsy.centralrepository.eventlisteners.IngestEventsListener.IngestModuleEventListener.propertyChange(), org.sleuthkit.autopsy.centralrepository.eventlisteners.NewArtifactsRunner.run(), org.sleuthkit.autopsy.centralrepository.eventlisteners.KnownStatusChangeRunner.run(), org.sleuthkit.autopsy.centralrepository.contentviewer.DataContentViewerOtherCases.setNode(), and org.sleuthkit.autopsy.centralrepository.actions.EamCaseEditDetailsDialog.updateDb().

void org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.newCase

(

CorrelationCase

eamCase

)

throws EamDbException

Creates new Case in the database

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

Parameters

eamCase

The case to add

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb.

Referenced by org.sleuthkit.autopsy.centralrepository.actions.EamCaseEditDetailsDialog.EamCaseEditDetailsDialog(), and org.sleuthkit.autopsy.centralrepository.eventlisteners.CaseEventListener.propertyChange().

CorrelationCase org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.newCase

(

Case

autopsyCase

)

throws EamDbException

Creates new Case in the database from the given case

Parameters

case	The case to add

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb.

int org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.newCorrelationType

(

CorrelationAttribute.Type

newType

)

throws EamDbException

Add a new EamArtifact.Type to the db.

Parameters

newType

New type to add.

Returns

Type.ID for newType

Exceptions

EamDbException

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb.

void org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.newDataSource

(

CorrelationDataSource

eamDataSource

)

throws EamDbException

Creates new Data Source in the database

Parameters

eamDataSource

the data source to add

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb.

Referenced by org.sleuthkit.autopsy.centralrepository.eventlisteners.CaseEventListener.propertyChange().

void org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.newDbInfo	(	String	name,
		String	value
	)		throws EamDbException

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

Parameters

name	Key to set
value	Value to set

Exceptions

EamDbException

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb.

void org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.newOrganization

(

EamOrganization

eamOrg

)

throws EamDbException

Add a new organization

Parameters

eamOrg

The organization to add

Exceptions

EamDbException

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb.

Referenced by org.sleuthkit.autopsy.centralrepository.optionspanel.AddNewOrganizationDialog.bnOKActionPerformed().

int org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.newReferencelSet

(

EamGlobalSet

eamGlobalSet

)

throws EamDbException

Add a new Global Set

Parameters

eamGlobalSet

The global set to add

Returns

The ID of the new global set

Exceptions

EamDbException

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb.

void org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.prepareBulkArtifact

(

CorrelationAttribute

eamArtifact

)

throws EamDbException

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 bulkInsertArtifacts().

Parameters

eamArtifact

The artifact to add

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb.

void org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.reset

(

)

throws EamDbException

Reset the database (testing method)

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDb.

void org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.saveSettings

(

)

Save settings

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDb.

void org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.setArtifactInstanceKnownStatus	(	CorrelationAttribute	eamArtifact,
		TskData.FileKnown	knownStatus
	)		throws EamDbException

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

Parameters

eamArtifact	Artifact containing exactly one (1) ArtifactInstance.
FileKnown	The status to change the artifact to

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb.

Referenced by org.sleuthkit.autopsy.centralrepository.eventlisteners.KnownStatusChangeRunner.run().

void org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.setBadTags

(

List< String >

tags

)

Set the tags recognized as "Bad"

Parameters

tags	The tags to consider bad

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb, org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb.

void org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.shutdownConnections

(

)

throws EamDbException

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

EamDbException

if there is a problem closing the connection pool.

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDb.

Referenced by org.sleuthkit.autopsy.centralrepository.optionspanel.EamDbSettingsDialog.bnOkActionPerformed().

void org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.updateCase

(

CorrelationCase

eamCase

)

throws EamDbException

Updates an existing Case in the database

Parameters

eamCase

The case to update

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb.

Referenced by org.sleuthkit.autopsy.centralrepository.eventlisteners.CaseEventListener.propertyChange(), and org.sleuthkit.autopsy.centralrepository.actions.EamCaseEditDetailsDialog.updateDb().

void org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.updateCorrelationType

(

CorrelationAttribute.Type

aType

)

throws EamDbException

Update a EamArtifact.Type.

Parameters

aType

EamArtifact.Type to update.

Exceptions

EamDbException

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb.

void org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.updateDbInfo	(	String	name,
		String	value
	)		throws EamDbException

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

Parameters

name	Name to find
value	Value to assign to name.

Exceptions

EamDbException

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.AbstractSqlEamDb.

void org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.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.

Implemented in org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDb, and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDb.

Referenced by org.sleuthkit.autopsy.centralrepository.optionspanel.EamDbSettingsDialog.bnOkActionPerformed().

Member Data Documentation

final int org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.SCHEMA_VERSION = 1

static

Definition at line 31 of file EamDb.java.

---

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

• /home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/centralrepository/datamodel/EamDb.java