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

Public Member Functions
boolean	equals (Object obj)
int	getBulkThreshold ()
String	getDbName ()
String	getHost ()
String	getPassword ()
int	getPort ()
String	getUserName ()
int	hashCode ()
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

Static Public Attributes
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 Private Member Functions
static void	validateNum (int num, Integer min, Integer max, String errMessage) throws CentralRepoException
static void	validateRegex (String s, String pattern, String errMessage) throws CentralRepoException
static void	validateStr (String s, String errMessage) throws CentralRepoException

Private Attributes
int	bulkThreshold = RdbmsCentralRepo.DEFAULT_BULK_THRESHHOLD
String	dbName = DEFAULT_DBNAME
String	host = DEFAULT_HOST
String	password = DEFAULT_PASSWORD
int	port = DEFAULT_PORT
String	userName = DEFAULT_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*"

Detailed Description

This class is a POJO for postgres settings to be used with central repository.

Definition at line 28 of file PostgresConnectionSettings.java.

Member Function Documentation

boolean org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.equals

(

Object

obj

)

Definition at line 191 of file PostgresConnectionSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.bulkThreshold, org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.dbName, org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.host, org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.password, org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.port, and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.userName.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.areCustomSettingsChanged().

int org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.getBulkThreshold

(

)

This method returns the bulk threshold.

Returns

The bulk threshold.

Definition at line 88 of file PostgresConnectionSettings.java.

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

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.saveCustomSettings().

String org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.getDbName

(

)

This method returns the database name for these settings.

Returns

The database name for these settings.

Definition at line 80 of file PostgresConnectionSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.dbName.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.getDbName(), and org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.saveCustomSettings().

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

(

)

This method retrieves the postgres host.

Returns

The host for these settings.

Definition at line 64 of file PostgresConnectionSettings.java.

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

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.getHost(), and org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.saveCustomSettings().

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

(

)

This method returns the password to use for this connection.

Returns

The password to use for this connection.

Definition at line 104 of file PostgresConnectionSettings.java.

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

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.getPassword(), and org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.saveCustomSettings().

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

(

)

This method returns the port number for these settings.

Returns

The port number for these settings.

Definition at line 72 of file PostgresConnectionSettings.java.

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

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.getPort(), and org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.saveCustomSettings().

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

(

)

This method returns the username to use for this connection.

Returns

The username to use.

Definition at line 96 of file PostgresConnectionSettings.java.

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

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.getUserName(), and org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.saveCustomSettings().

int org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.hashCode

(

)

Definition at line 178 of file PostgresConnectionSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.bulkThreshold, and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.port.

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

(

int

bulkThreshold

)

throws CentralRepoException

This method sets the bulk threshold of this connection.

Parameters

bulkThreshold

The bulk threshold to set (must be greater than 0).

Definition at line 148 of file PostgresConnectionSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.bulkThreshold, and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.validateNum().

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.loadCustomSettings(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.setBulkThreshold().

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

(

String

dbName

)

throws CentralRepoException

This methods sets the name of the database. NOTE: this name needs to be a valid postgres database name.

Parameters

dbName

The database name.

Definition at line 135 of file PostgresConnectionSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.validateRegex(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.validateStr().

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.loadCustomSettings(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.setDbName().

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

(

String

host

)

throws CentralRepoException

This method sets the host for this connection. NOTE: must be non-empty string.

Parameters

host	the host to set

Definition at line 114 of file PostgresConnectionSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.host, and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.validateStr().

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.loadCustomSettings(), org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.loadMultiUserSettings(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.setHost().

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

(

String

password

)

throws CentralRepoException

This method sets the password for this connection.

Parameters

password

The password to set.

Definition at line 172 of file PostgresConnectionSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.password, and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.validateStr().

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.loadCustomSettings(), org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.loadMultiUserSettings(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.setPassword().

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

(

int

port

)

throws CentralRepoException

This method sets the port for this connection.

Parameters

port	The port to set (must be [1,65535]).

Definition at line 124 of file PostgresConnectionSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.port, and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.validateNum().

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.loadCustomSettings(), org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.loadMultiUserSettings(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.setPort().

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

(

String

userName

)

throws CentralRepoException

This method sets the username for this connection. NOTE: must be a valid postgres username.

Parameters

userName

The user name to set.

Definition at line 159 of file PostgresConnectionSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.userName, org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.validateRegex(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.validateStr().

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.loadCustomSettings(), org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.loadMultiUserSettings(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresCentralRepoSettings.setUserName().

static void org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.validateNum ( int  num, Integer  min, Integer  max, String  errMessage  ) throws CentralRepoException

staticprivate

Definition at line 48 of file PostgresConnectionSettings.java.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.setBulkThreshold(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.setPort().

static void org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.validateRegex ( String  s, String  pattern, String  errMessage  ) throws CentralRepoException

staticprivate

Definition at line 43 of file PostgresConnectionSettings.java.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.setDbName(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.setUserName().

static void org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.validateStr ( String  s, String  errMessage  ) throws CentralRepoException

staticprivate

Definition at line 38 of file PostgresConnectionSettings.java.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.setDbName(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.setHost(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.setPassword(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.setUserName().

Member Data Documentation

int org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.bulkThreshold = RdbmsCentralRepo.DEFAULT_BULK_THRESHHOLD

private

Definition at line 56 of file PostgresConnectionSettings.java.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.equals(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.getBulkThreshold(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.hashCode(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.setBulkThreshold().

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

staticprivate

Definition at line 29 of file PostgresConnectionSettings.java.

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

staticprivate

Definition at line 30 of file PostgresConnectionSettings.java.

String org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.dbName = DEFAULT_DBNAME

private

Definition at line 55 of file PostgresConnectionSettings.java.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.equals(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.getDbName().

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

static

Definition at line 34 of file PostgresConnectionSettings.java.

final String org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.DEFAULT_HOST = ""

static

Definition at line 32 of file PostgresConnectionSettings.java.

final String org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.DEFAULT_PASSWORD = ""

static

Definition at line 36 of file PostgresConnectionSettings.java.

final int org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.DEFAULT_PORT = 5432

static

Definition at line 33 of file PostgresConnectionSettings.java.

Referenced by org.sleuthkit.autopsy.integrationtesting.IntegrationTestService.pushCentralRepoSettings(), and org.sleuthkit.autopsy.integrationtesting.IntegrationTestService.pushPostgresSettings().

final String org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.DEFAULT_USERNAME = ""

static

Definition at line 35 of file PostgresConnectionSettings.java.

String org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.host = DEFAULT_HOST

private

Definition at line 53 of file PostgresConnectionSettings.java.

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

String org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.password = DEFAULT_PASSWORD

private

Definition at line 58 of file PostgresConnectionSettings.java.

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

int org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.port = DEFAULT_PORT

private

Definition at line 54 of file PostgresConnectionSettings.java.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.equals(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.getPort(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.hashCode(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.setPort().

String org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.userName = DEFAULT_USERNAME

private

Definition at line 57 of file PostgresConnectionSettings.java.

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

---

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

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