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

Public Member Functions
	SqliteCentralRepoSettings ()

boolean	createDatabase ()

boolean	createDbDirectory ()

boolean	dbDirectoryExists ()

boolean	dbFileExists ()

boolean	deleteDatabase ()

String	getDbDirectory ()

String	getDbName ()

String	getFileNameWithPath ()

void	loadSettings ()

void	saveSettings ()

void	setDbDirectory (String dbDirectory) throws CentralRepoException

void	setDbName (String dbName) throws CentralRepoException

void	setupDefaultSettings ()

DatabaseTestResult	testStatus ()

String	toString ()

boolean	verifyConnection ()

boolean	verifyDatabaseExists ()

boolean	verifyDatabaseSchema ()

Static Public Attributes
static final String	DEFAULT_DBNAME = CentralRepoSettings.getInstance().getDefaultDbName()

Private Member Functions
String	readDbPath ()

void	saveDbPath (String fullPath)

Private Attributes
int	bulkThreshold

String	dbDirectory

String	dbName

final Path	userConfigDir = Paths.get(PlatformUtil.getUserDirectory().getAbsolutePath())

Static Private Attributes
static final String	BULK_THRESHOLD = "db.sqlite.bulkThreshold"

static final String	DATABASE_NAME = CentralRepoSettings.getInstance().getDatabaseNameKey()

static final String	DATABASE_PATH = CentralRepoSettings.getInstance().getDatabasePathKey()

static final String	DB_NAMES_REGEX = "[a-z][a-z0-9_]*(\\.db)?"

static final String	DEFAULT_DBDIRECTORY = CentralRepoSettings.getInstance().getDefaultDbPath()

static final String	JDBC_BASE_URI = "jdbc:sqlite:"

static final String	JDBC_DRIVER = "org.sqlite.JDBC"

static final Logger	LOGGER = Logger.getLogger(SqliteCentralRepoSettings.class.getName())

static final String	PROFILE_NAME = CentralRepoSettings.getInstance().getModuleSettingsKey()

static final String	VALIDATION_QUERY = "SELECT count(*) from sqlite_master"

Detailed Description

Settings for the sqlite 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 SqliteCentralRepoSettings.java.

Constructor & Destructor Documentation

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

Definition at line 65 of file SqliteCentralRepoSettings.java.

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

Member Function Documentation

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

creates database directory for sqlite database if it does not exist

Returns: whether or not operation occurred successfully

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

Definition at line 214 of file SqliteCentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.createDbDirectory().

boolean org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.createDbDirectory ( )

Create the db directory if it does not exist.

Returns: true is successfully created or already exists, else false

Definition at line 223 of file SqliteCentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.dbDirectoryExists(), and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.getDbDirectory().

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.createDatabase(), and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.saveSettings().

boolean org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.dbDirectoryExists ( )

Verify that the db directory path exists.

Returns: true if exists, else false

Definition at line 194 of file SqliteCentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.getDbDirectory().

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.createDbDirectory(), and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.verifyDatabaseExists().

boolean org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.dbFileExists ( )

Verify that the db file exists.

Returns: true if exists, else false

Definition at line 175 of file SqliteCentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.getFileNameWithPath().

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

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

Delete the database

Returns

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

Definition at line 243 of file SqliteCentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.getFileNameWithPath().

String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.getDbDirectory ( )

Returns: the dbDirectory

Definition at line 373 of file SqliteCentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.dbDirectory.

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

Returns: the dbName

Definition at line 333 of file SqliteCentralRepoSettings.java.

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

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.getFileNameWithPath(), org.sleuthkit.autopsy.centralrepository.optionspanel.GlobalSettingsPanel.load(), org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.saveSettings(), and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.toString().

String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.getFileNameWithPath ( )

Join the DbDirectory and the DbName into a full path.

Returns

Definition at line 397 of file SqliteCentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.getDbDirectory(), and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.getDbName().

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.dbFileExists(), and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.deleteDatabase().

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

This method loads the current settings for this connection.

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

Definition at line 69 of file SqliteCentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.DEFAULT_DBDIRECTORY, org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.DEFAULT_DBNAME, org.sleuthkit.autopsy.coreutils.ModuleSettings.getConfigSetting(), and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.readDbPath().

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

String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.readDbPath ( )

private

Read CD database path from preferences file. Reverses the path relativization performed in saveDbPath(). If the stored path starts with either “/” or drive letter, it is a full path, and is returned to the caller. Otherwise, append current user directory to the saved relative path. See JIRA-7348.

Returns: Full path to the SQLite CR database file.

Definition at line 142 of file SqliteCentralRepoSettings.java.

References org.sleuthkit.autopsy.coreutils.ModuleSettings.getConfigSetting().

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

void org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.saveDbPath ( String fullPath )

private

Save CR database path. If the path is inside user directory (e.g. "C:\Users\USER_NAME\AppData\Roaming\autopsy"), trim that off and save it as a relative path (i.e it will not start with a “/” or drive letter). Otherwise, full path is saved. See JIRA-7348.

Parameters

fullPath Full path to the SQLite db file.

Definition at line 123 of file SqliteCentralRepoSettings.java.

References org.sleuthkit.autopsy.coreutils.ModuleSettings.setConfigSetting().

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.saveSettings().

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

This method saves the altered settings to disk.

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

Definition at line 107 of file SqliteCentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.createDbDirectory(), org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.getDbDirectory(), org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.getDbName(), org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.saveDbPath(), and org.sleuthkit.autopsy.coreutils.ModuleSettings.setConfigSetting().

void org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.setDbDirectory ( String dbDirectory ) throws CentralRepoException

Path for directory to hold the sqlite database.

User must have WRITE permission to this directory.

Parameters

dbDirectory the dbDirectory to set

Definition at line 384 of file SqliteCentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.dbDirectory.

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

void org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.setDbName ( String dbName ) throws CentralRepoException

Name of the sqlite db file.

Parameters

dbName the dbName to set

Definition at line 342 of file SqliteCentralRepoSettings.java.

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

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

void org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.setupDefaultSettings ( )

sets database directory and name to defaults

Definition at line 102 of file SqliteCentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.DEFAULT_DBDIRECTORY, and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.DEFAULT_DBNAME.

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

DatabaseTestResult org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.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 423 of file SqliteCentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.DatabaseTestResult.DB_DOES_NOT_EXIST, org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.dbFileExists(), org.sleuthkit.autopsy.centralrepository.datamodel.DatabaseTestResult.SCHEMA_INVALID, org.sleuthkit.autopsy.centralrepository.datamodel.DatabaseTestResult.TESTED_OK, org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.verifyConnection(), and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.verifyDatabaseSchema().

String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.toString ( )

Definition at line 95 of file SqliteCentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.getDbDirectory(), and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.getDbName().

boolean org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.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 292 of file SqliteCentralRepoSettings.java.

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

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

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

This method checks to see if the database exists.

Returns: True if exists, else false.

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

Definition at line 185 of file SqliteCentralRepoSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.dbDirectoryExists().

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

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

Returns: true if successfull connection, else false.

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

Definition at line 309 of file SqliteCentralRepoSettings.java.

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

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

Member Data Documentation

final String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.BULK_THRESHOLD = "db.sqlite.bulkThreshold"

staticprivate

Definition at line 54 of file SqliteCentralRepoSettings.java.

int org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.bulkThreshold

private

Definition at line 63 of file SqliteCentralRepoSettings.java.

final String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.DATABASE_NAME = CentralRepoSettings.getInstance().getDatabaseNameKey()

staticprivate

Definition at line 52 of file SqliteCentralRepoSettings.java.

final String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.DATABASE_PATH = CentralRepoSettings.getInstance().getDatabasePathKey()

staticprivate

Definition at line 53 of file SqliteCentralRepoSettings.java.

final String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.DB_NAMES_REGEX = "[a-z][a-z0-9_]*(\\.db)?"

staticprivate

Definition at line 60 of file SqliteCentralRepoSettings.java.

String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.dbDirectory

private

Definition at line 62 of file SqliteCentralRepoSettings.java.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.getDbDirectory(), and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.setDbDirectory().

String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.dbName

private

Definition at line 61 of file SqliteCentralRepoSettings.java.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.getDbName(), and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.setDbName().

final String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.DEFAULT_DBDIRECTORY = CentralRepoSettings.getInstance().getDefaultDbPath()

staticprivate

Definition at line 48 of file SqliteCentralRepoSettings.java.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.loadSettings(), and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.setupDefaultSettings().

final String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.DEFAULT_DBNAME = CentralRepoSettings.getInstance().getDefaultDbName()

static

Definition at line 45 of file SqliteCentralRepoSettings.java.

Referenced by org.sleuthkit.autopsy.centralrepository.optionspanel.EamDbSettingsDialog.EamDbSettingsDialog(), org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.loadSettings(), org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.setupDefaultSettings(), org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoDbManager.testDatabaseSettingsAreValid(), and org.sleuthkit.autopsy.centralrepository.optionspanel.EamDbSettingsDialog.updateFullDbPath().

final String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.JDBC_BASE_URI = "jdbc:sqlite:"

staticprivate

Definition at line 57 of file SqliteCentralRepoSettings.java.

final String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.JDBC_DRIVER = "org.sqlite.JDBC"

staticprivate

Definition at line 56 of file SqliteCentralRepoSettings.java.

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

staticprivate

Definition at line 46 of file SqliteCentralRepoSettings.java.

final String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.PROFILE_NAME = CentralRepoSettings.getInstance().getModuleSettingsKey()

staticprivate

Definition at line 51 of file SqliteCentralRepoSettings.java.

final Path org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.userConfigDir = Paths.get(PlatformUtil.getUserDirectory().getAbsolutePath())

private

Definition at line 47 of file SqliteCentralRepoSettings.java.

final String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.VALIDATION_QUERY = "SELECT count(*) from sqlite_master"

staticprivate

Definition at line 58 of file SqliteCentralRepoSettings.java.

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

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

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation