Package org.duracloud.common.util

Class DatabaseUtil

java.lang.Object

org.duracloud.common.util.DatabaseUtil

public abstract class DatabaseUtil
extends Object

 This abstract class provides the ability to create/clear/remove a database
 and its tables.
 It also provides a 'javax.sql.DataSource' for the database.
 Finally, sql operations can be executed on the database through the retrieval
 of the 'JdbcOperations' object provided by the method: getOps().
 

Author:

Andrew Woods

Field Summary

Fields

Modifier and Type	Field	Description
protected org.slf4j.Logger	log
static String	NOT_ENCRYPTED

Constructor Summary

Constructors

Constructor	Description
DatabaseUtil(Credential cred, String baseDir)
DatabaseUtil(Credential cred, String baseDir, String bootPassword)

Method Summary

Modifier and Type	Method	Description
void	clearDB()
void	disconnect()
void	ensureDatabaseExists()
void	ensureTablesExist()
protected void	execute(String sql)
DataSource	getDataSource()
org.springframework.jdbc.core.JdbcOperations	getOps()
org.springframework.jdbc.core.JdbcTemplate	getSimpleJdbcTemplate()
protected abstract List<TableSpec>	getTableSpecs()
void	initializeDB()	This method sets-up empty tables for this database.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.slf4j.Logger log

NOT_ENCRYPTED

public static String NOT_ENCRYPTED

Constructor Detail

DatabaseUtil

public DatabaseUtil(Credential cred,
                    String baseDir)

DatabaseUtil

public DatabaseUtil(Credential cred,
                    String baseDir,
                    String bootPassword)

Method Detail

getTableSpecs

protected abstract List<TableSpec> getTableSpecs()

initializeDB

public void initializeDB()
                  throws Exception

This method sets-up empty tables for this database.

Throws:

Exception

ensureDatabaseExists

public void ensureDatabaseExists()

ensureTablesExist

public void ensureTablesExist()
                       throws SQLException

Throws:

SQLException

clearDB

public void clearDB()

disconnect

public void disconnect()

getSimpleJdbcTemplate

public org.springframework.jdbc.core.JdbcTemplate getSimpleJdbcTemplate()

getDataSource

public DataSource getDataSource()

getOps

public org.springframework.jdbc.core.JdbcOperations getOps()

execute

protected void execute(String sql)