org.sleuthkit.autopsy.centralrepository.CentralRepoSettings Class Reference

Public Member Functions
String	getDatabaseNameKey ()
String	getDatabasePathKey ()
String	getDefaultDbName ()
String	getDefaultDbPath ()
String	getModuleSettingsFile ()
String	getModuleSettingsKey ()
String	getSettingsBaseFolder ()

Static Public Member Functions
static CentralRepoSettings	getInstance ()

Static Private Attributes
static final String	CENTRAL_REPO_BASE_PATH
static final String	CENTRAL_REPOSITORY_FOLDER = "CentralRepository"
static final String	CENTRAL_REPOSITORY_SETTINGS_NAME = "CentralRepository"
static final String	DATABASE_NAME_KEY = "db.sqlite.dbName"
static final String	DATABASE_PATH_KEY = "db.sqlite.dbDirectory"
static final String	DEFAULT_DB_NAME = "central_repository.db"
static final String	DEFAULT_DB_PARENT_PATH = Paths.get(CENTRAL_REPO_BASE_PATH, "LocalDatabase").toString()
static final CentralRepoSettings	instance = new CentralRepoSettings()
static final String	MODULE_SETTINGS_KEY
static final String	MODULE_SETTINGS_PROPERTIES

Detailed Description

Location for central repo settings and paths.

Definition at line 28 of file CentralRepoSettings.java.

Member Function Documentation

String org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.getDatabaseNameKey

(

)

Returns

The properties key for the sqlite database name in the settings.

Definition at line 100 of file CentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.DATABASE_NAME_KEY.

Referenced by org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer.upgradeSettingsPath().

String org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.getDatabasePathKey

(

)

Returns

The properties key for the sqlite database path in the settings.

Definition at line 107 of file CentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.DATABASE_PATH_KEY.

Referenced by org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer.upgradeSettingsPath().

String org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.getDefaultDbName

(

)

Returns

The default sqlite database name.

Definition at line 93 of file CentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.DEFAULT_DB_NAME.

String org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.getDefaultDbPath

(

)

Returns

The default database parent path for sqlite cr.

Definition at line 86 of file CentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.DEFAULT_DB_PARENT_PATH.

Referenced by org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer.upgradeSettingsPath().

static CentralRepoSettings org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.getInstance ( )

static

Returns

The singleton instance of this class.

Definition at line 35 of file CentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.instance.

Referenced by org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.getCRNotableList(), org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer.setupDefaultCentralRepository(), and org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer.upgradeSettingsPath().

String org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.getModuleSettingsFile

(

)

Returns

The path to the central repo settings.

Definition at line 79 of file CentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.MODULE_SETTINGS_PROPERTIES.

String org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.getModuleSettingsKey

(

)

Returns

The module settings key that places the settings file within getSettingsBaseFolder.

Definition at line 72 of file CentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.MODULE_SETTINGS_KEY.

Referenced by org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.getCRNotableList(), org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer.setupDefaultCentralRepository(), and org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer.upgradeSettingsPath().

String org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.getSettingsBaseFolder

(

)

Returns

The base path for central repository settings.

Definition at line 64 of file CentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.CENTRAL_REPO_BASE_PATH.

Member Data Documentation

final String org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.CENTRAL_REPO_BASE_PATH

staticprivate

Initial value:

= Paths.get(
            PlatformUtil.getModuleConfigDirectory(),
            CENTRAL_REPOSITORY_FOLDER).toString()

Definition at line 41 of file CentralRepoSettings.java.

Referenced by org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.getSettingsBaseFolder().

final String org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.CENTRAL_REPOSITORY_FOLDER = "CentralRepository"

staticprivate

Definition at line 39 of file CentralRepoSettings.java.

final String org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.CENTRAL_REPOSITORY_SETTINGS_NAME = "CentralRepository"

staticprivate

Definition at line 40 of file CentralRepoSettings.java.

final String org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.DATABASE_NAME_KEY = "db.sqlite.dbName"

staticprivate

Definition at line 58 of file CentralRepoSettings.java.

Referenced by org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.getDatabaseNameKey().

final String org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.DATABASE_PATH_KEY = "db.sqlite.dbDirectory"

staticprivate

Definition at line 59 of file CentralRepoSettings.java.

Referenced by org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.getDatabasePathKey().

final String org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.DEFAULT_DB_NAME = "central_repository.db"

staticprivate

Definition at line 46 of file CentralRepoSettings.java.

Referenced by org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.getDefaultDbName().

final String org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.DEFAULT_DB_PARENT_PATH = Paths.get(CENTRAL_REPO_BASE_PATH, "LocalDatabase").toString()

staticprivate

Definition at line 45 of file CentralRepoSettings.java.

Referenced by org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.getDefaultDbPath().

final CentralRepoSettings org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.instance = new CentralRepoSettings()

staticprivate

Definition at line 30 of file CentralRepoSettings.java.

Referenced by org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.getInstance().

final String org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.MODULE_SETTINGS_KEY

staticprivate

Initial value:

= Paths.get(
            Paths.get(PlatformUtil.getUserConfigDirectory()).relativize(Paths.get(PlatformUtil.getModuleConfigDirectory())).toString(),
            CENTRAL_REPOSITORY_FOLDER,
            CENTRAL_REPOSITORY_SETTINGS_NAME).toString()

Definition at line 49 of file CentralRepoSettings.java.

Referenced by org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.getModuleSettingsKey().

final String org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.MODULE_SETTINGS_PROPERTIES

staticprivate

Initial value:

= Paths.get(
            CENTRAL_REPO_BASE_PATH,
            CENTRAL_REPOSITORY_SETTINGS_NAME + ".properties").toString()

Definition at line 54 of file CentralRepoSettings.java.

Referenced by org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.getModuleSettingsFile().

---

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

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