org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings Class Reference

Inherits org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbConnectivityManager.

Public Member Functions
	PostgresCentralRepoSettings (PostgresSettingsLoader loader)
	PostgresCentralRepoSettings () throws CentralRepoException
boolean	createDatabase ()
boolean	deleteDatabase ()
String	getDbName ()
String	getHost ()
String	getPassword ()
int	getPort ()
String	getUserName ()
void	loadSettings ()
void	saveSettings ()
void	setBulkThreshold (int bulkThreshold) throws CentralRepoException
void	setDbName (String dbName) throws CentralRepoException
void	setHost (String host) throws CentralRepoException
void	setPassword (String password) throws CentralRepoException
void	setPort (int port) throws CentralRepoException
void	setUserName (String userName) throws CentralRepoException
DatabaseTestResult	testStatus ()
String	toString ()
boolean	verifyConnection ()
boolean	verifyDatabaseExists ()
boolean	verifyDatabaseSchema ()

Static Private Member Functions
static PostgresSettingsLoader	getLoaderFromSaved () throws CentralRepoException

Private Attributes
PostgresConnectionSettings	connSettings
final PostgresSettingsLoader	loader

Static Private Attributes
static final String	JDBC_BASE_URI = "jdbc:postgresql://"
static final String	JDBC_DRIVER = "org.postgresql.Driver"
static final Logger	LOGGER = Logger.getLogger(PostgresCentralRepoSettings.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 37 of file PostgresCentralRepoSettings.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.PostgresCentralRepoSettings

(

PostgresSettingsLoader

loader

)

This method loads the settings with a custom PostgresSettingsLoader object.

Parameters

loader

The loader to be used.

Definition at line 62 of file PostgresCentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.loader, and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.loadSettings().

org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.PostgresCentralRepoSettings

(

)

throws CentralRepoException

This is the default constructor that loads settings from selected db choice.

Definition at line 70 of file PostgresCentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.getLoaderFromSaved().

Member Function Documentation

boolean org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.createDatabase

(

)

This method will create a central repository database if necessary.

Returns

Whether or not the operation was successful.

Implements org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbConnectivityManager.

Definition at line 235 of file PostgresCentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbUtil.closeConnection(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.getDbName(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.getUserName().

boolean org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.deleteDatabase

(

)

This method deletes a central repository database (used for deleting a corrupted database).

Returns

Whether or not the operation was successful.

Implements org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbConnectivityManager.

Definition at line 257 of file PostgresCentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbUtil.closeConnection(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.getDbName().

String org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.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 313 of file PostgresCentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.getDbName().

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

String org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.getHost

(

)

Returns

the host

Definition at line 282 of file PostgresCentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.getHost().

Referenced by org.sleuthkit.autopsy.centralrepository.optionspanel.GlobalSettingsPanel.load(), org.sleuthkit.autopsy.centralrepository.optionspanel.GlobalSettingsPanel.onMultiUserChange(), org.sleuthkit.autopsy.integrationtesting.IntegrationTestService.pushCentralRepoSettings(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.toString(), and org.sleuthkit.autopsy.centralrepository.optionspanel.EamDbSettingsDialog.updatePostgresFields().

static PostgresSettingsLoader org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.getLoaderFromSaved ( ) throws CentralRepoException

staticprivate

Definition at line 48 of file PostgresCentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresSettingsLoader.CUSTOM_SETTINGS_LOADER, org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbManager.getSavedDbChoice(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresSettingsLoader.MULTIUSER_SETTINGS_LOADER, org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbChoice.POSTGRESQL_CUSTOM, and org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbChoice.POSTGRESQL_MULTIUSER.

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

String org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.getPassword

(

)

Returns

the password

Definition at line 355 of file PostgresCentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.getPassword().

Referenced by org.sleuthkit.autopsy.integrationtesting.IntegrationTestService.pushCentralRepoSettings(), and org.sleuthkit.autopsy.centralrepository.optionspanel.EamDbSettingsDialog.updatePostgresFields().

int org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.getPort

(

)

Returns

the port

Definition at line 296 of file PostgresCentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.getPort().

Referenced by org.sleuthkit.autopsy.integrationtesting.IntegrationTestService.pushCentralRepoSettings(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.toString(), and org.sleuthkit.autopsy.centralrepository.optionspanel.EamDbSettingsDialog.updatePostgresFields().

String org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.getUserName

(

)

Returns

the userName

Definition at line 341 of file PostgresCentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.getUserName().

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.createDatabase(), org.sleuthkit.autopsy.integrationtesting.IntegrationTestService.pushCentralRepoSettings(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.toString(), and org.sleuthkit.autopsy.centralrepository.optionspanel.EamDbSettingsDialog.updatePostgresFields().

void org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.loadSettings

(

)

This method loads the current settings for this connection.

Implements org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbConnectivityManager.

Definition at line 76 of file PostgresCentralRepoSettings.java.

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

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

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

(

)

This method saves the altered settings to disk.

Implements org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbConnectivityManager.

Definition at line 81 of file PostgresCentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresSettingsLoader.saveSettings().

Referenced by org.sleuthkit.autopsy.integrationtesting.IntegrationTestService.pushCentralRepoSettings().

void org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.setBulkThreshold

(

int

bulkThreshold

)

throws CentralRepoException

Parameters

bulkThreshold

the bulkThreshold to set

Definition at line 334 of file PostgresCentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.setBulkThreshold().

void org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.setDbName

(

String

dbName

)

throws CentralRepoException

Parameters

dbName

the dbName to set

Definition at line 320 of file PostgresCentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.setDbName().

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

void org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.setHost

(

String

host

)

throws CentralRepoException

Parameters

host	the host to set

Definition at line 289 of file PostgresCentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.setHost().

Referenced by org.sleuthkit.autopsy.integrationtesting.IntegrationTestService.pushCentralRepoSettings(), and org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbManager.testDatabaseSettingsAreValid().

void org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.setPassword

(

String

password

)

throws CentralRepoException

Parameters

password

the password to set

Definition at line 362 of file PostgresCentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.setPassword().

Referenced by org.sleuthkit.autopsy.integrationtesting.IntegrationTestService.pushCentralRepoSettings(), and org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbManager.testDatabaseSettingsAreValid().

void org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.setPort

(

int

port

)

throws CentralRepoException

Parameters

port	the port to set

Definition at line 303 of file PostgresCentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.setPort().

Referenced by org.sleuthkit.autopsy.integrationtesting.IntegrationTestService.pushCentralRepoSettings(), and org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbManager.testDatabaseSettingsAreValid().

void org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.setUserName

(

String

userName

)

throws CentralRepoException

Parameters

userName

the userName to set

Definition at line 348 of file PostgresCentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.setUserName().

Referenced by org.sleuthkit.autopsy.integrationtesting.IntegrationTestService.pushCentralRepoSettings(), and org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbManager.testDatabaseSettingsAreValid().

DatabaseTestResult org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.testStatus

(

)

This method tests the connectivity status of this connection and returns the testing result.

Returns

The result of testing the database connectivity status.

Implements org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbConnectivityManager.

Definition at line 367 of file PostgresCentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.DatabaseTestResult.CONNECTION_FAILED, org.sleuthkit.autopsy.centralrepository.datamodel.DatabaseTestResult.DB_DOES_NOT_EXIST, org.sleuthkit.autopsy.centralrepository.datamodel.DatabaseTestResult.SCHEMA_INVALID, org.sleuthkit.autopsy.centralrepository.datamodel.DatabaseTestResult.TESTED_OK, org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.verifyConnection(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.verifyDatabaseExists(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.verifyDatabaseSchema().

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

String org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.toString

(

)

Definition at line 87 of file PostgresCentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.getDbName(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.getHost(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.getPort(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.getUserName().

boolean org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.verifyConnection

(

)

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

Returns

true if successfull connection, else false.

Implements org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbConnectivityManager.

Definition at line 171 of file PostgresCentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbUtil.closeConnection(), and org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbUtil.executeValidationQuery().

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.testStatus().

boolean org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.verifyDatabaseExists

(

)

Check to see if the database exists.

Returns

true if exists, else false

Implements org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbConnectivityManager.

Definition at line 188 of file PostgresCentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbUtil.closeConnection(), org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbUtil.closeResultSet(), org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbUtil.closeStatement(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.getDbName().

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.testStatus().

boolean org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.verifyDatabaseSchema

(

)

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

Returns

true if successful connection, else false.

Implements org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbConnectivityManager.

Definition at line 222 of file PostgresCentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbUtil.closeConnection(), and org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbUtil.schemaVersionIsSet().

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.testStatus().

Member Data Documentation

PostgresConnectionSettings org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.connSettings

private

Definition at line 46 of file PostgresCentralRepoSettings.java.

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

staticprivate

Definition at line 41 of file PostgresCentralRepoSettings.java.

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

staticprivate

Definition at line 42 of file PostgresCentralRepoSettings.java.

final PostgresSettingsLoader org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.loader

private

Definition at line 45 of file PostgresCentralRepoSettings.java.

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

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

staticprivate

Definition at line 39 of file PostgresCentralRepoSettings.java.

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

staticprivate

Definition at line 40 of file PostgresCentralRepoSettings.java.

---

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

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