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

Public Member Functions

 SqliteEamDbSettings ()
 
boolean createDbDirectory ()
 
boolean dbDirectoryExists ()
 
boolean dbFileExists ()
 
boolean deleteDatabase ()
 
List< String > getBadTags ()
 
int getBulkThreshold ()
 
String getConnectionURL ()
 
String getDbDirectory ()
 
String getDbName ()
 
String getDriver ()
 
String getFileNameWithPath ()
 
String getJDBCBaseURI ()
 
String getValidationQuery ()
 
boolean initializeDatabaseSchema ()
 
boolean insertDefaultDatabaseContent ()
 
boolean isChanged ()
 
void loadSettings ()
 
void saveSettings ()
 
void setBadTags (List< String > badTags)
 
void setBulkThreshold (int bulkThreshold) throws EamDbException
 
void setDbDirectory (String dbDirectory) throws EamDbException
 
void setDbName (String dbName) throws EamDbException
 
boolean verifyConnection ()
 
boolean verifyDatabaseSchema ()
 

Private Member Functions

Connection getEphemeralConnection ()
 

Private Attributes

List< String > badTags
 
int bulkThreshold
 
final String DB_NAMES_REGEX = "[a-z][a-z0-9_]*(\\.db)?"
 
String dbDirectory
 
String dbName
 
final String DEFAULT_BAD_TAGS = "Evidence"
 
final int DEFAULT_BULK_THRESHHOLD = 1000
 
final String DEFAULT_DBDIRECTORY = PlatformUtil.getUserDirectory() + File.separator + "central_repository"
 
final String DEFAULT_DBNAME = "central_repository.db"
 
final String JDBC_BASE_URI = "jdbc:sqlite:"
 
final String JDBC_DRIVER = "org.sqlite.JDBC"
 
final String VALIDATION_QUERY = "SELECT count(*) from sqlite_master"
 

Static Private Attributes

static final Logger LOGGER = Logger.getLogger(SqliteEamDbSettings.class.getName())
 
static final String PRAGMA_ENCODING_UTF8 = "PRAGMA encoding = 'UTF-8'"
 
static final String PRAGMA_FOREIGN_KEYS_ON = "PRAGMA foreign_keys = ON"
 
static final String PRAGMA_JOURNAL_WAL = "PRAGMA journal_mode = WAL"
 
static final String PRAGMA_PAGE_SIZE_4096 = "PRAGMA page_size = 4096"
 
static final String PRAGMA_READ_UNCOMMITTED_TRUE = "PRAGMA read_uncommitted = True"
 
static final String PRAGMA_SYNC_NORMAL = "PRAGMA synchronous = NORMAL"
 
static final String PRAGMA_SYNC_OFF = "PRAGMA synchronous = OFF"
 

Detailed Description

Settings for the sqlite implementation of the Central Repository database

Definition at line 41 of file SqliteEamDbSettings.java.

Constructor & Destructor Documentation

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

Member Function Documentation

boolean org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.createDbDirectory ( )
boolean org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.dbDirectoryExists ( )
boolean org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.dbFileExists ( )
boolean org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.deleteDatabase ( )
List<String> org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.getBadTags ( )
int org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.getBulkThreshold ( )
String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.getConnectionURL ( )
String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.getDbDirectory ( )
String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.getDbName ( )
String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.getDriver ( )
Connection org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.getEphemeralConnection ( )
private
String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.getFileNameWithPath ( )
String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.getJDBCBaseURI ( )
String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.getValidationQuery ( )
boolean org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.initializeDatabaseSchema ( )

Initialize the database schema.

Requires valid connectionPool.

This method is called from within connect(), so we cannot call connect() to get a connection. This method is called after setupConnectionPool(), so it is safe to assume that a valid connectionPool exists. The implementation of connect() is synchronized, so we can safely use the connectionPool object directly.

Definition at line 258 of file SqliteEamDbSettings.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.closeConnection(), org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.correlationTypeToInstanceTableName(), org.sleuthkit.autopsy.centralrepository.datamodel.EamDbUtil.correlationTypeToReferenceTableName(), org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.FILES_TYPE_ID, org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.getDefaultCorrelationTypes(), and org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.getEphemeralConnection().

Referenced by org.sleuthkit.autopsy.centralrepository.optionspanel.EamDbSettingsDialog.createDb().

boolean org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.insertDefaultDatabaseContent ( )
boolean org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.isChanged ( )
void org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.loadSettings ( )
void org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.saveSettings ( )
void org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.setBadTags ( List< String >  badTags)
void org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.setBulkThreshold ( int  bulkThreshold) throws EamDbException
Parameters
bulkThresholdthe bulkThreshold to set

Definition at line 493 of file SqliteEamDbSettings.java.

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

void org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.setDbDirectory ( String  dbDirectory) throws EamDbException

Path for directory to hold the sqlite database.

User must have WRITE permission to this directory.

Parameters
dbDirectorythe dbDirectory to set

Definition at line 529 of file SqliteEamDbSettings.java.

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

Referenced by org.sleuthkit.autopsy.centralrepository.optionspanel.EamDbSettingsDialog.databaseSettingsAreValid().

void org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.setDbName ( String  dbName) throws EamDbException
boolean org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.verifyConnection ( )
boolean org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.verifyDatabaseSchema ( )

Member Data Documentation

List<String> org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.badTags
private
int org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.bulkThreshold
private
final String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.DB_NAMES_REGEX = "[a-z][a-z0-9_]*(\\.db)?"
private

Definition at line 58 of file SqliteEamDbSettings.java.

String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.dbDirectory
private
String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.dbName
private
final String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.DEFAULT_BAD_TAGS = "Evidence"
private
final int org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.DEFAULT_BULK_THRESHHOLD = 1000
private
final String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.DEFAULT_DBDIRECTORY = PlatformUtil.getUserDirectory() + File.separator + "central_repository"
private
final String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.DEFAULT_DBNAME = "central_repository.db"
private
final String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.JDBC_BASE_URI = "jdbc:sqlite:"
private
final String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.JDBC_DRIVER = "org.sqlite.JDBC"
private
final Logger org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.LOGGER = Logger.getLogger(SqliteEamDbSettings.class.getName())
staticprivate

Definition at line 43 of file SqliteEamDbSettings.java.

final String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.PRAGMA_ENCODING_UTF8 = "PRAGMA encoding = 'UTF-8'"
staticprivate

Definition at line 55 of file SqliteEamDbSettings.java.

final String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.PRAGMA_FOREIGN_KEYS_ON = "PRAGMA foreign_keys = ON"
staticprivate

Definition at line 57 of file SqliteEamDbSettings.java.

final String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.PRAGMA_JOURNAL_WAL = "PRAGMA journal_mode = WAL"
staticprivate

Definition at line 53 of file SqliteEamDbSettings.java.

final String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.PRAGMA_PAGE_SIZE_4096 = "PRAGMA page_size = 4096"
staticprivate

Definition at line 56 of file SqliteEamDbSettings.java.

final String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.PRAGMA_READ_UNCOMMITTED_TRUE = "PRAGMA read_uncommitted = True"
staticprivate

Definition at line 54 of file SqliteEamDbSettings.java.

final String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.PRAGMA_SYNC_NORMAL = "PRAGMA synchronous = NORMAL"
staticprivate

Definition at line 52 of file SqliteEamDbSettings.java.

final String org.sleuthkit.autopsy.centralrepository.datamodel.SqliteEamDbSettings.PRAGMA_SYNC_OFF = "PRAGMA synchronous = OFF"
staticprivate

Definition at line 51 of file SqliteEamDbSettings.java.

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

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

Copyright © 2012-2016 Basis Technology. Generated on: Fri Sep 29 2017
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.