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

Classes

interface  ValueSetter
 

Public Member Functions

boolean areCustomSettingsChanged (PostgresConnectionSettings settings)
 
PostgresConnectionSettings loadCustomSettings ()
 
PostgresConnectionSettings loadMultiUserSettings ()
 
void saveCustomSettings (PostgresConnectionSettings settings)
 

Static Public Member Functions

static synchronized CentralRepoPostgresSettingsUtil getInstance ()
 

Private Member Functions

 CentralRepoPostgresSettingsUtil ()
 
void setValOrLog (ValueSetter setter, String value)
 

Static Private Attributes

static final String BULK_THRESHOLD_KEY = "db.postgresql.bulkThreshold"
 
static final String DBNAME_KEY = "db.postgresql.dbName"
 
static final String HOST_KEY = "db.postgresql.host"
 
static CentralRepoPostgresSettingsUtil instance = null
 
static final Logger LOGGER = Logger.getLogger(CentralRepoPostgresSettingsUtil.class.getName())
 
static final String MODULE_KEY = "CentralRepository"
 
static final String PASSWORD_KEY = "db.postgresql.password"
 
static final String PORT_KEY = "db.postgresql.port"
 
static final String USER_KEY = "db.postgresql.user"
 

Detailed Description

This class handles saving and loading of postgres settings for central repository.

Definition at line 39 of file CentralRepoPostgresSettingsUtil.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.CentralRepoPostgresSettingsUtil ( )
private

Definition at line 64 of file CentralRepoPostgresSettingsUtil.java.

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

Member Function Documentation

boolean org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.areCustomSettingsChanged ( PostgresConnectionSettings  settings)

This method checks if saved settings differ from the in-memory object provided in the 'settings' parameter.

Parameters
settingsThe in-memory object.
Returns
Whether or not settings parameter differs from saved custom settings.

Definition at line 181 of file CentralRepoPostgresSettingsUtil.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.equals(), and org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.loadCustomSettings().

static synchronized CentralRepoPostgresSettingsUtil org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.getInstance ( )
static

This method retrieves a singleton instance of this class.

Returns
The singleton instance of this class.

Definition at line 57 of file CentralRepoPostgresSettingsUtil.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.CentralRepoPostgresSettingsUtil(), and org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.instance.

PostgresConnectionSettings org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.loadCustomSettings ( )

This method loads the custom postgres settings for central repository. If settings could not be loaded, default values will be returned.

Returns
The settings loaded from custom postgres settings.

Definition at line 127 of file CentralRepoPostgresSettingsUtil.java.

References org.sleuthkit.autopsy.coreutils.TextConverter.convertHexTextToText(), org.sleuthkit.autopsy.coreutils.ModuleSettings.getConfigSettings(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.setBulkThreshold(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.setDbName(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.setHost(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.setPassword(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.setPort(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.setUserName(), and org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.setValOrLog().

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.areCustomSettingsChanged(), and org.sleuthkit.autopsy.centralrepository.datamodel.PostgresSettingsLoader.Custom.loadSettings().

PostgresConnectionSettings org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.loadMultiUserSettings ( )

This method loads multi-user settings to be used as a postgres connection to central repository. If settings could not be loaded, default values will be returned.

Returns
The settings loaded from multi-user settings.

Definition at line 100 of file CentralRepoPostgresSettingsUtil.java.

References org.sleuthkit.autopsy.core.UserPreferences.getDatabaseConnectionInfo(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.setHost(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.setPassword(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.setPort(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.setUserName(), and org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.setValOrLog().

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.PostgresSettingsLoader.MultiUser.loadSettings().

void org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.saveCustomSettings ( PostgresConnectionSettings  settings)

This method saves the settings for a custom postgres central repository connection.

Parameters
settingsThe settings to save.

Definition at line 160 of file CentralRepoPostgresSettingsUtil.java.

References org.sleuthkit.autopsy.coreutils.TextConverter.convertTextToHexText(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.getBulkThreshold(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.getDbName(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.getHost(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.getPassword(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.getPort(), org.sleuthkit.autopsy.centralrepository.datamodel.PostgresConnectionSettings.getUserName(), and org.sleuthkit.autopsy.coreutils.ModuleSettings.setConfigSettings().

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.PostgresSettingsLoader.Custom.saveSettings().

void org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.setValOrLog ( ValueSetter  setter,
String  value 
)
private

Uses setter object to set a value as specified by 'value'. In the event that 'value' is null, the setter will not be called. Exceptions that are raised from the setter will be logged.

Parameters
setterThe setter to call.
valueThe value to use with the setter.

Definition at line 74 of file CentralRepoPostgresSettingsUtil.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.ValueSetter.set().

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

Member Data Documentation

final String org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.BULK_THRESHOLD_KEY = "db.postgresql.bulkThreshold"
staticprivate

Definition at line 43 of file CentralRepoPostgresSettingsUtil.java.

final String org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.DBNAME_KEY = "db.postgresql.dbName"
staticprivate

Definition at line 46 of file CentralRepoPostgresSettingsUtil.java.

final String org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.HOST_KEY = "db.postgresql.host"
staticprivate

Definition at line 47 of file CentralRepoPostgresSettingsUtil.java.

CentralRepoPostgresSettingsUtil org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.instance = null
staticprivate

Definition at line 51 of file CentralRepoPostgresSettingsUtil.java.

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

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

Definition at line 40 of file CentralRepoPostgresSettingsUtil.java.

final String org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.MODULE_KEY = "CentralRepository"
staticprivate

Definition at line 49 of file CentralRepoPostgresSettingsUtil.java.

final String org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.PASSWORD_KEY = "db.postgresql.password"
staticprivate

Definition at line 42 of file CentralRepoPostgresSettingsUtil.java.

final String org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.PORT_KEY = "db.postgresql.port"
staticprivate

Definition at line 44 of file CentralRepoPostgresSettingsUtil.java.

final String org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoPostgresSettingsUtil.USER_KEY = "db.postgresql.user"
staticprivate

Definition at line 45 of file CentralRepoPostgresSettingsUtil.java.

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

Copyright © 2012-2021 Basis Technology. Generated on: Tue Jan 19 2021
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.