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

Public Member Functions

 PostgresEamDbSettings ()
 
boolean createDatabase ()
 
boolean deleteDatabase ()
 
String getDbName ()
 
String getHost ()
 
String getPassword ()
 
int getPort ()
 
String getUserName ()
 
boolean initializeDatabaseSchema ()
 
boolean insertDefaultDatabaseContent ()
 
void loadSettings ()
 
void saveSettings ()
 
void setBulkThreshold (int bulkThreshold) throws EamDbException
 
void setDbName (String dbName) throws EamDbException
 
void setHost (String host) throws EamDbException
 
void setPassword (String password) throws EamDbException
 
void setPort (int port) throws EamDbException
 
void setUserName (String userName) throws EamDbException
 
boolean verifyConnection ()
 
boolean verifyDatabaseExists ()
 
boolean verifyDatabaseSchema ()
 

Private Member Functions

Connection getEphemeralConnection (boolean usePostgresDb)
 

Private Attributes

int bulkThreshold
 
String dbName
 
String host
 
String password
 
int port
 
String userName
 

Static Private Attributes

static final String DB_NAMES_REGEX = "[a-z][a-z0-9_]*"
 
static final String DB_USER_NAMES_REGEX = "[a-zA-Z]\\w*"
 
static final String DEFAULT_DBNAME = "central_repository"
 
static final String DEFAULT_HOST = ""
 
static final String DEFAULT_PASSWORD = ""
 
static final int DEFAULT_PORT = 5432
 
static final String DEFAULT_USERNAME = ""
 
static final String JDBC_BASE_URI = "jdbc:postgresql://"
 
static final String JDBC_DRIVER = "org.postgresql.Driver"
 
static final Logger LOGGER = Logger.getLogger(PostgresEamDbSettings.class.getName())
 
static final String VALIDATION_QUERY = "SELECT version()"
 

Detailed Description

Settings for the Postgres implementation of the Central Repository database

NOTE: This is public scope because the options panel calls it directly to set/get

Definition at line 43 of file PostgresEamDbSettings.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.PostgresEamDbSettings ( )

Definition at line 63 of file PostgresEamDbSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.loadSettings().

Member Function Documentation

boolean org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.createDatabase ( )

Definition at line 251 of file PostgresEamDbSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.closeConnection(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.getDbName(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.getEphemeralConnection(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.getUserName().

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

boolean org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.deleteDatabase ( )

Definition at line 272 of file PostgresEamDbSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.closeConnection(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.getDbName(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.getEphemeralConnection().

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

String org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.getDbName ( )

To prevent issues where one command can honor case and another cannot, we will force the dbname to lower case.

Returns
the dbName

Definition at line 651 of file PostgresEamDbSettings.java.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.createDatabase(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.deleteDatabase(), org.sleuthkit.autopsy.centralrepository.optionspanel.GlobalSettingsPanel.load(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.saveSettings(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.verifyDatabaseExists().

Connection org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.getEphemeralConnection ( boolean  usePostgresDb)
private

Use the current settings to get an ephemeral client connection for testing.

Returns
Connection or null.

Definition at line 165 of file PostgresEamDbSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.getPassword(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.getUserName().

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.createDatabase(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.deleteDatabase(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.initializeDatabaseSchema(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.insertDefaultDatabaseContent(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.verifyConnection(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.verifyDatabaseExists(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.verifyDatabaseSchema().

String org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.getHost ( )
Returns
the host

Definition at line 612 of file PostgresEamDbSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.host.

Referenced by org.sleuthkit.autopsy.centralrepository.optionspanel.GlobalSettingsPanel.load(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.saveSettings(), and org.sleuthkit.autopsy.centralrepository.optionspanel.EamDbSettingsDialog.updatePostgresFields().

String org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.getPassword ( )
Returns
the password

Definition at line 708 of file PostgresEamDbSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.password.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.getEphemeralConnection(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.saveSettings(), and org.sleuthkit.autopsy.centralrepository.optionspanel.EamDbSettingsDialog.updatePostgresFields().

int org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.getPort ( )
Returns
the port

Definition at line 630 of file PostgresEamDbSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.port.

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

String org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.getUserName ( )
Returns
the userName

Definition at line 689 of file PostgresEamDbSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.userName.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.createDatabase(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.getEphemeralConnection(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.saveSettings(), and org.sleuthkit.autopsy.centralrepository.optionspanel.EamDbSettingsDialog.updatePostgresFields().

boolean org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.initializeDatabaseSchema ( )

Initialize the database schema.

Requires valid connectionPool.

This method is called from within connect(), so we cannot call connect() to get a connection. This method is called after setupConnectionPool(), so it is safe to assume that a valid connectionPool exists. The implementation of connect() is synchronized, so we can safely use the connectionPool object directly.

Definition at line 304 of file PostgresEamDbSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.closeConnection(), org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.correlationTypeToInstanceTableName(), org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.correlationTypeToReferenceTableName(), org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeInstance.FILES_TYPE_ID, org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeInstance.getDefaultCorrelationTypes(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.getEphemeralConnection().

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

boolean org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.insertDefaultDatabaseContent ( )

Definition at line 584 of file PostgresEamDbSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.closeConnection(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.getEphemeralConnection(), and org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.insertDefaultCorrelationTypes().

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

void org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.loadSettings ( )

Definition at line 67 of file PostgresEamDbSettings.java.

References org.sleuthkit.autopsy.coreutils.TextConverter.convertHexTextToText(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.DEFAULT_DBNAME, org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.DEFAULT_HOST, org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.DEFAULT_PASSWORD, org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.DEFAULT_PORT, org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.DEFAULT_USERNAME, and org.sleuthkit.autopsy.coreutils.ModuleSettings.getConfigSetting().

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.PostgresEamDbSettings().

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

Definition at line 124 of file PostgresEamDbSettings.java.

References org.sleuthkit.autopsy.coreutils.TextConverter.convertTextToHexText(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.getDbName(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.getHost(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.getPassword(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.getUserName(), and org.sleuthkit.autopsy.coreutils.ModuleSettings.setConfigSetting().

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

void org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.setBulkThreshold ( int  bulkThreshold) throws EamDbException
Parameters
bulkThresholdthe bulkThreshold to set

Definition at line 678 of file PostgresEamDbSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.bulkThreshold.

void org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.setDbName ( String  dbName) throws EamDbException
Parameters
dbNamethe dbName to set

Definition at line 658 of file PostgresEamDbSettings.java.

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

void org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.setHost ( String  host) throws EamDbException
Parameters
hostthe host to set

Definition at line 619 of file PostgresEamDbSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.host.

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

void org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.setPassword ( String  password) throws EamDbException
Parameters
passwordthe password to set

Definition at line 715 of file PostgresEamDbSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.password.

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

void org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.setPort ( int  port) throws EamDbException
Parameters
portthe port to set

Definition at line 637 of file PostgresEamDbSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.port.

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

void org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.setUserName ( String  userName) throws EamDbException
Parameters
userNamethe userName to set

Definition at line 696 of file PostgresEamDbSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.userName.

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

boolean org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.verifyConnection ( )

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

Returns
true if successfull connection, else false.

Definition at line 190 of file PostgresEamDbSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.closeConnection(), org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.executeValidationQuery(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.getEphemeralConnection().

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

boolean org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.verifyDatabaseExists ( )

Check to see if the database exists.

Returns
true if exists, else false

Definition at line 206 of file PostgresEamDbSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.closeConnection(), org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.closeResultSet(), org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.closeStatement(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.getDbName(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.getEphemeralConnection().

Referenced by org.sleuthkit.autopsy.centralrepository.optionspanel.EamDbSettingsDialog.createDb(), and org.sleuthkit.autopsy.centralrepository.optionspanel.EamDbSettingsDialog.testDbSettings().

boolean org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.verifyDatabaseSchema ( )

Use the current settings and the schema version query to test the database schema.

Returns
true if successful connection, else false.

Definition at line 239 of file PostgresEamDbSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.closeConnection(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.getEphemeralConnection(), and org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.schemaVersionIsSet().

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

Member Data Documentation

int org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.bulkThreshold
private

Definition at line 59 of file PostgresEamDbSettings.java.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.setBulkThreshold().

final String org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.DB_NAMES_REGEX = "[a-z][a-z0-9_]*"
staticprivate

Definition at line 54 of file PostgresEamDbSettings.java.

final String org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.DB_USER_NAMES_REGEX = "[a-zA-Z]\\w*"
staticprivate

Definition at line 55 of file PostgresEamDbSettings.java.

String org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.dbName
private

Definition at line 58 of file PostgresEamDbSettings.java.

final String org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.DEFAULT_DBNAME = "central_repository"
staticprivate

Definition at line 48 of file PostgresEamDbSettings.java.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.loadSettings().

final String org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.DEFAULT_HOST = ""
staticprivate

Definition at line 46 of file PostgresEamDbSettings.java.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.loadSettings().

final String org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.DEFAULT_PASSWORD = ""
staticprivate

Definition at line 50 of file PostgresEamDbSettings.java.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.loadSettings().

final int org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.DEFAULT_PORT = 5432
staticprivate

Definition at line 47 of file PostgresEamDbSettings.java.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.loadSettings().

final String org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.DEFAULT_USERNAME = ""
staticprivate

Definition at line 49 of file PostgresEamDbSettings.java.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.loadSettings().

String org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.host
private

Definition at line 56 of file PostgresEamDbSettings.java.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.getHost(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.setHost().

final String org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.JDBC_BASE_URI = "jdbc:postgresql://"
staticprivate

Definition at line 52 of file PostgresEamDbSettings.java.

final String org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.JDBC_DRIVER = "org.postgresql.Driver"
staticprivate

Definition at line 53 of file PostgresEamDbSettings.java.

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

Definition at line 45 of file PostgresEamDbSettings.java.

String org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.password
private

Definition at line 61 of file PostgresEamDbSettings.java.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.getPassword(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.setPassword().

int org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.port
private

Definition at line 57 of file PostgresEamDbSettings.java.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.getPort(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.setPort().

String org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.userName
private

Definition at line 60 of file PostgresEamDbSettings.java.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.getUserName(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.setUserName().

final String org.sleuthkit.autopsy.centralrepository.datamodel.PostgresEamDbSettings.VALIDATION_QUERY = "SELECT version()"
staticprivate

Definition at line 51 of file PostgresEamDbSettings.java.

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

Copyright © 2012-2018 Basis Technology. Generated on: Wed Sep 18 2019
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.