Static Public Member Functions
static boolean	allowUseOfCentralRepository ()

static void	closeConnection (Connection conn)

static void	closePreparedStatement (PreparedStatement preparedStatement)

static void	closeResultSet (ResultSet resultSet)

static void	closeStatement (Statement statement)

static String	correlationTypeToInstanceTableName (CorrelationAttributeInstance.Type type)

static String	correlationTypeToReferenceTableName (CorrelationAttributeInstance.Type type)

static boolean	executeValidationQuery (Connection conn, String validationQuery)

static String	getDefaultOrgName ()

static boolean	insertDefaultCorrelationTypes (Connection conn)

static boolean	isDefaultOrg (EamOrganization org)

static boolean	schemaVersionIsSet (Connection conn)

static void	setUseCentralRepo (boolean centralRepoCheckBoxIsSelected)

static void	upgradeDatabase () throws EamDbException

Static Private Attributes
static final String	CENTRAL_REPO_NAME = "CentralRepository"

static final String	CENTRAL_REPO_USE_KEY = "db.useCentralRepo"

static final String	DEFAULT_ORG_NAME = "Not Specified"

static final Logger	LOGGER = Logger.getLogger(EamDbUtil.class.getName())

Detailed Description

Definition at line 38 of file EamDbUtil.java.

Member Function Documentation

static boolean org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.allowUseOfCentralRepository ( )

static

If the option to use a central repository has been selected, does not indicate the central repository is configured for use simply that the checkbox allowing configuration is checked on the options panel.

Returns: true if the Central Repo may be configured, false if it should not be able to be

Definition at line 302 of file EamDbUtil.java.

References org.sleuthkit.autopsy.coreutils.ModuleSettings.getConfigSetting().

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.getInstance(), org.sleuthkit.autopsy.centralrepository.datamodel.EamDb.isEnabled(), and org.sleuthkit.autopsy.centralrepository.optionspanel.GlobalSettingsPanel.load().

static void org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.closeConnection ( Connection conn )

static

Close the in-use connection and return it to the pool.

Parameters

conn	An open connection

Exceptions

EamDbException

Definition at line 86 of file EamDbUtil.java.

static void org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.closePreparedStatement ( PreparedStatement preparedStatement )

static

Close the prepared statement.

Parameters

preparedStatement The prepared statement to be closed.

Deprecated:: Use closeStatement() instead.

Exceptions

EamDbException

Definition at line 378 of file EamDbUtil.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.closeStatement().

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.insertDefaultCorrelationTypes().

static void org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.closeResultSet ( ResultSet resultSet )

static

Close the resultSet.

Parameters

resultSet

Exceptions

EamDbException

Definition at line 69 of file EamDbUtil.java.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.executeValidationQuery(), org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.schemaVersionIsSet(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.verifyDatabaseExists().

static void org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.closeStatement ( Statement statement )

static

Close the statement.

Parameters

statement The statement to be closed.

Exceptions

EamDbException

Definition at line 52 of file EamDbUtil.java.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.closePreparedStatement(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.verifyDatabaseExists().

static String org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.correlationTypeToInstanceTableName ( CorrelationAttributeInstance.Type type )

static

Conver thte Type's DbTableName string to the *_instances table name.

Parameters

type	Correlation Type

Returns: Instance table name for this Type.

Definition at line 353 of file EamDbUtil.java.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.initializeDatabaseSchema(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.initializeDatabaseSchema().

static String org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.correlationTypeToReferenceTableName ( CorrelationAttributeInstance.Type type )

static

Convert the Type's DbTableName string to the reference_* table name.

Parameters

type	Correlation Type

Returns: Reference table name for this Type.

Definition at line 364 of file EamDbUtil.java.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.initializeDatabaseSchema(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.initializeDatabaseSchema().

static boolean org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.executeValidationQuery	(	Connection	conn,
		String	validationQuery
	)

static

Use the current settings and the validation query to test the connection to the database.

Returns: true if successfull query execution, else false.

Definition at line 325 of file EamDbUtil.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.closeResultSet().

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.verifyConnection(), and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.verifyConnection().

static String org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.getDefaultOrgName ( )

static

Get the default organization name

Returns: the default org name

Definition at line 248 of file EamDbUtil.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.DEFAULT_ORG_NAME.

static boolean org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.insertDefaultCorrelationTypes ( Connection conn )

static

Insert the default correlation types into the database.

Parameters

conn	Open connection to use.

Returns: true on success, else false

Definition at line 103 of file EamDbUtil.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.closePreparedStatement(), and org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeInstance.getDefaultCorrelationTypes().

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.insertDefaultDatabaseContent(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.insertDefaultDatabaseContent().

static boolean org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.isDefaultOrg ( EamOrganization org )

static

Check whether the given org is the default organization.

Parameters

org

Returns: true if it is the default org, false otherwise

Definition at line 259 of file EamDbUtil.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.EamOrganization.getName().

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

static boolean org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.schemaVersionIsSet ( Connection conn )

static

Query to see if the SCHEMA_VERSION is set in the db.

Returns: true if set, else false.

Definition at line 148 of file EamDbUtil.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.closeResultSet().

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.verifyDatabaseSchema(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.verifyDatabaseSchema().

static void org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.setUseCentralRepo ( boolean centralRepoCheckBoxIsSelected )

static

Saves the setting for whether the Central Repo should be able to be configured.

Parameters

centralRepoCheckBoxIsSelected - true if the central repo can be used

Definition at line 315 of file EamDbUtil.java.

References org.sleuthkit.autopsy.coreutils.ModuleSettings.setConfigSetting().

Referenced by org.sleuthkit.autopsy.centralrepository.optionspanel.GlobalSettingsPanel.store().

static void org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.upgradeDatabase ( ) throws EamDbException

static

Upgrade the current Central Reposity schema to the newest version. If the upgrade fails, the Central Repository will be disabled and the current settings will be cleared.

Definition at line 178 of file EamDbUtil.java.

Referenced by org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer.restored(), and org.sleuthkit.autopsy.centralrepository.optionspanel.GlobalSettingsPanel.updateDatabase().

Member Data Documentation

final String org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.CENTRAL_REPO_NAME = "CentralRepository"

staticprivate

Definition at line 41 of file EamDbUtil.java.

final String org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.CENTRAL_REPO_USE_KEY = "db.useCentralRepo"

staticprivate

Definition at line 42 of file EamDbUtil.java.

final String org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.DEFAULT_ORG_NAME = "Not Specified"

staticprivate

Definition at line 43 of file EamDbUtil.java.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.getDefaultOrgName().

final Logger org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.LOGGER = Logger.getLogger(EamDbUtil.class.getName())

staticprivate

Definition at line 40 of file EamDbUtil.java.

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

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

Static Public Member Functions

Static Private Attributes

Detailed Description

Member Function Documentation

Member Data Documentation