com.absio.database

Class DataAccess

java.lang.Object

com.absio.database.DataAccess

public class DataAccess
extends Object

This class represents the data access for the database used in the OFSProvider to store all relevant data locally. It uses the Users, PublicKeys, Containers and Accesses tables.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATABASE_LOCATION_SEED_SUFFIX

Constructor Summary

Constructors

Constructor and Description
DataAccess(String location, String hexEncodedAes256Key) Constructor with the DatabaseWrapper's location and hexEncodedAes256Key.
DataAccess(String location, String hexEncodedAes256Key, int version) Constructor with the DatabaseWrapper's location, hexEncodedAes256Key and version.

Method Summary

Modifier and Type	Method and Description
void	closeDatabase() If the database is open this will close the JDBC Connection.
Statement	createStatement() Creates a Statement using the JDBC Connection.
void	destroyDatabase() This will close the JDBC Connection and then delete the database file.
long	executeCountQueryWithParameters(ParameterizedSql parameterizedSql) This will execute the count query with the given parameters and return the result.
int	executeUpdateWithParameters(ParameterizedSql parameterizedSql) The will execute the given sql as an update with the given parameters (insert, update, delete, etc).
int	getVersion() Get the version of the database.
DatabaseOpenState	openOrCreateDatabase() This will open or create the database.
PreparedStatement	prepareStatement(ParameterizedSql parameterizedSql) Create a PreparedStatement for the given sql and fill the parameters.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DATABASE_LOCATION_SEED_SUFFIX

public static final String DATABASE_LOCATION_SEED_SUFFIX

See Also:

Constant Field Values

Constructor Detail

DataAccess

public DataAccess(String location,
                  String hexEncodedAes256Key)

Constructor with the DatabaseWrapper's location and hexEncodedAes256Key. This will set the version of the database to CURRENT_VERSION.

Parameters:

location - the file location of the DatabaseWrapper

hexEncodedAes256Key - the hex encoded AES 256 key of the DatabaseWrapper

DataAccess

public DataAccess(String location,
                  String hexEncodedAes256Key,
                  int version)

Constructor with the DatabaseWrapper's location, hexEncodedAes256Key and version.

Parameters:

location - the file location of the DatabaseWrapper

hexEncodedAes256Key - the hex encoded AES 256 key of the DatabaseWrapper

version - the version of the database

Method Detail

closeDatabase

public void closeDatabase()
                   throws SQLException

If the database is open this will close the JDBC Connection.

Throws:

SQLException - thrown if there was an issue closing the Connection

createStatement

public Statement createStatement()
                          throws SQLException

Creates a Statement using the JDBC Connection.

NOTE: the database must be open before you call this method.

Returns:

the Statement

Throws:

SQLException - thrown if there was an issue creating the Statement

destroyDatabase

public void destroyDatabase()
                     throws IOException,
                            SQLException

This will close the JDBC Connection and then delete the database file.

NOTE: the database file will be deleted and cannot be recovered!

Throws:

IOException - thrown if there was an issue deleting the database file

SQLException - thrown if there was an issue closing the Connection

executeCountQueryWithParameters

public long executeCountQueryWithParameters(ParameterizedSql parameterizedSql)
                                     throws SQLException

This will execute the count query with the given parameters and return the result.

NOTE: the database must be open before you call this method.

Parameters:

parameterizedSql - the count query to run and the parameters for the query

Returns:

the count

Throws:

SQLException - thrown if there was an issue executing the count query

executeUpdateWithParameters

public int executeUpdateWithParameters(ParameterizedSql parameterizedSql)
                                throws SQLException

The will execute the given sql as an update with the given parameters (insert, update, delete, etc).

NOTE: the database must be open before you call this method.

Parameters:

parameterizedSql - the update sql to execute and the parameters to use in the execution

Returns:

the number of rows affected by the execution

Throws:

SQLException - thrown if there is an issue executing the update

getVersion

public int getVersion()

Get the version of the database.

Returns:

the version of the database

openOrCreateDatabase

public DatabaseOpenState openOrCreateDatabase()
                                       throws IOException,
                                              SQLException

This will open or create the database. If opening the database the version number will be checked to see if an upgrade needs to happen. If creating the database all of the tables will be created.

Returns:

the open state of the database (new or open)

Throws:

IOException - thrown if there was an issue with the database location

SQLException - thrown if there was an issue creating or opening the database

prepareStatement

public PreparedStatement prepareStatement(ParameterizedSql parameterizedSql)
                                   throws SQLException

Create a PreparedStatement for the given sql and fill the parameters.

NOTE: the database must be open before you call this method.

Parameters:

parameterizedSql - the sql to create a PreparedStatement with and the parameters to fill the statement with

Returns:

the PreparedStatement

Throws:

SQLException - thrown if there was an issue creating the PreparedStatement