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

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 = "central_repository.db"
 

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 = "db.sqlite.dbName"
 
static final String DATABASE_PATH = "db.sqlite.dbDirectory"
 
static final String DB_NAMES_REGEX = "[a-z][a-z0-9_]*(\\.db)?"
 
static final String DEFAULT_DBDIRECTORY = PlatformUtil.getUserDirectory() + File.separator + "central_repository"
 
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 = "CentralRepository"
 
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 42 of file SqliteCentralRepoSettings.java.

Constructor & Destructor Documentation

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

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 213 of file SqliteCentralRepoSettings.java.

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

boolean org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.createDbDirectory ( )
boolean org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.dbDirectoryExists ( )
boolean org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.dbFileExists ( )
boolean org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.deleteDatabase ( )
String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.getDbDirectory ( )
String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.getDbName ( )
String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.getFileNameWithPath ( )
void org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.loadSettings ( )
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 141 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
fullPathFull path to the SQLite db file.

Definition at line 122 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 ( )
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
dbDirectorythe dbDirectory to set

Definition at line 383 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
void org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.setupDefaultSettings ( )
DatabaseTestResult org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.testStatus ( )
String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.toString ( )
boolean org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.verifyConnection ( )
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 184 of file SqliteCentralRepoSettings.java.

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

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

Member Data Documentation

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

Definition at line 53 of file SqliteCentralRepoSettings.java.

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

Definition at line 62 of file SqliteCentralRepoSettings.java.

final String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.DATABASE_NAME = "db.sqlite.dbName"
staticprivate

Definition at line 51 of file SqliteCentralRepoSettings.java.

final String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.DATABASE_PATH = "db.sqlite.dbDirectory"
staticprivate

Definition at line 52 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 59 of file SqliteCentralRepoSettings.java.

String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.dbDirectory
private
String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.dbName
private
final String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.DEFAULT_DBDIRECTORY = PlatformUtil.getUserDirectory() + File.separator + "central_repository"
staticprivate
final String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.DEFAULT_DBNAME = "central_repository.db"
static
final String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.JDBC_BASE_URI = "jdbc:sqlite:"
staticprivate

Definition at line 56 of file SqliteCentralRepoSettings.java.

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

Definition at line 55 of file SqliteCentralRepoSettings.java.

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

Definition at line 45 of file SqliteCentralRepoSettings.java.

final String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteCentralRepoSettings.PROFILE_NAME = "CentralRepository"
staticprivate

Definition at line 50 of file SqliteCentralRepoSettings.java.

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

Definition at line 46 of file SqliteCentralRepoSettings.java.

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

Definition at line 57 of file SqliteCentralRepoSettings.java.


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

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