Package org.xipki.datasource

Class DataSourceWrapper

java.lang.Object

org.xipki.datasource.DataSourceWrapper

All Implemented Interfaces:

Closeable, AutoCloseable

public abstract class DataSourceWrapper
extends Object
implements Closeable

A wrapper of HikariDataSource.

Since:

2.0.0

Author:

Lijun Liao (xipki)

Field Summary

Fields

Modifier and Type	Field	Description
protected String	name
protected com.zaxxer.hikari.HikariDataSource	service	References the real data source implementation this class acts as pure proxy for.

Method Summary

Modifier and Type	Method	Description
void	addForeignKeyConstraint(Connection conn, String constraintName, String baseTable, String baseColumn, String referencedTable, String referencedColumn, String onDeleteAction, String onUpdateAction)
void	addPrimaryKey(Connection conn, String primaryKeyName, String table, String... columns)
void	addUniqueConstrain(Connection conn, String constraintName, String table, String... columns)
protected String	buildAndCacheNextSeqValueSql(String sequenceName)
protected abstract String	buildCreateSequenceSql(String sequenceName, long startValue)
protected abstract String	buildDropSequenceSql(String sequenceName)
protected abstract String	buildNextSeqValueSql(String sequenceName)
String	buildSelectFirstSql(int rows, String coreSql)
abstract String	buildSelectFirstSql(int rows, String orderBy, String coreSql)
void	close()
boolean	columnExists(Connection conn, String table, String column, Object value)
void	createIndex(Connection conn, String indexName, String table, String... columns)
void	createSequence(String sequenceName, long startValue)
Statement	createStatement()
Statement	createStatement(Connection conn)
boolean	deleteFromTable(Connection conn, String table, String idColumn, long id)
void	deleteFromTableWithException(Connection conn, String table, String idColumn, long id)
void	dropAndCreateSequence(String sequenceName, long startValue)
void	dropForeignKeyConstraint(Connection conn, String constraintName, String baseTable)
void	dropIndex(Connection conn, String table, String indexName)
void	dropPrimaryKey(Connection conn, String primaryKeyName, String table)
void	dropSequence(String sequenceName)
void	dropUniqueConstrain(Connection conn, String constraintName, String table)
Connection	getConnection()
int	getCount(Connection conn, String table)
DatabaseType	getDatabaseType()
Integer	getFirstIntValue(Connection conn, String table, String column, String criteria)
Long	getFirstLongValue(Connection conn, String table, String column, String criteria)
String	getFirstStringValue(Connection conn, String table, String column, String criteria)
PrintWriter	getLogWriter()
long	getMax(Connection conn, String table, String column)
long	getMax(Connection conn, String table, String column, String condition)
int	getMaximumPoolSize()
long	getMin(Connection conn, String table, String column)
long	getMin(Connection conn, String table, String column, String condition)
String	getName()
protected String	getSqlToAddForeignKeyConstraint(String constraintName, String baseTable, String baseColumn, String referencedTable, String referencedColumn, String onDeleteAction, String onUpdateAction)
protected String	getSqlToAddPrimaryKey(String primaryKeyName, String table, String... columns)
protected String	getSqlToAddUniqueConstrain(String constraintName, String table, String... columns)
protected String	getSqlToCreateIndex(String indexName, String table, String... columns)
protected String	getSqlToDropForeignKeyConstraint(String constraintName, String baseTable)
protected String	getSqlToDropIndex(String table, String indexName)
protected String	getSqlToDropPrimaryKey(String primaryKeyName, String table)
protected String	getSqlToDropUniqueConstraint(String constraintName, String table)
protected boolean	isUseSqlStateAsCode()
long	nextSeqValue(Connection conn, String sequenceName)
PreparedStatement	prepareStatement(String sqlQuery)
PreparedStatement	prepareStatement(Connection conn, String sqlQuery)
void	releaseResources(Statement ps, ResultSet rs)
void	releaseResources(Statement ps, ResultSet rs, boolean returnConnection)
void	returnConnection(Connection conn)
void	setLastUsedSeqValue(String sequenceName, long sequenceValue)
boolean	tableExists(Connection conn, String table)
boolean	tableHasColumn(Connection conn, String table, String column)
DataAccessException	translate(String sql, SQLException ex)

Methods inherited from class java.lang.Object

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

Field Detail

service

protected final com.zaxxer.hikari.HikariDataSource service

References the real data source implementation this class acts as pure proxy for. Derived classes must set this field at construction time.

name

protected final String name

Method Detail

getName

public final String getName()

getDatabaseType

public final DatabaseType getDatabaseType()

getMaximumPoolSize

public final int getMaximumPoolSize()

getConnection

public final Connection getConnection()
                               throws DataAccessException

Throws:

DataAccessException

returnConnection

public void returnConnection(Connection conn)

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

getLogWriter

public final PrintWriter getLogWriter()
                               throws SQLException

Throws:

SQLException

createStatement

public Statement createStatement(Connection conn)
                          throws DataAccessException

Throws:

DataAccessException

createStatement

public Statement createStatement()
                          throws DataAccessException

Throws:

DataAccessException

prepareStatement

public PreparedStatement prepareStatement(Connection conn,
                                          String sqlQuery)
                                   throws DataAccessException

Throws:

DataAccessException

prepareStatement

public PreparedStatement prepareStatement(String sqlQuery)
                                   throws DataAccessException

Throws:

DataAccessException

releaseResources

public void releaseResources(Statement ps,
                             ResultSet rs)

releaseResources

public void releaseResources(Statement ps,
                             ResultSet rs,
                             boolean returnConnection)

buildSelectFirstSql

public String buildSelectFirstSql(int rows,
                                  String coreSql)

buildSelectFirstSql

public abstract String buildSelectFirstSql(int rows,
                                           String orderBy,
                                           String coreSql)

getFirstStringValue

public String getFirstStringValue(Connection conn,
                                  String table,
                                  String column,
                                  String criteria)
                           throws DataAccessException

Throws:

DataAccessException

getFirstIntValue

public Integer getFirstIntValue(Connection conn,
                                String table,
                                String column,
                                String criteria)
                         throws DataAccessException

Throws:

DataAccessException

getFirstLongValue

public Long getFirstLongValue(Connection conn,
                              String table,
                              String column,
                              String criteria)
                       throws DataAccessException

Throws:

DataAccessException

getMin

public long getMin(Connection conn,
                   String table,
                   String column)
            throws DataAccessException

Throws:

DataAccessException

getMin

public long getMin(Connection conn,
                   String table,
                   String column,
                   String condition)
            throws DataAccessException

Throws:

DataAccessException

getCount

public int getCount(Connection conn,
                    String table)
             throws DataAccessException

Throws:

DataAccessException

getMax

public long getMax(Connection conn,
                   String table,
                   String column)
            throws DataAccessException

Throws:

DataAccessException

getMax

public long getMax(Connection conn,
                   String table,
                   String column,
                   String condition)
            throws DataAccessException

Throws:

DataAccessException

deleteFromTable

public boolean deleteFromTable(Connection conn,
                               String table,
                               String idColumn,
                               long id)

deleteFromTableWithException

public void deleteFromTableWithException(Connection conn,
                                         String table,
                                         String idColumn,
                                         long id)
                                  throws SQLException,
                                         DataAccessException

Throws:

SQLException

DataAccessException

columnExists

public boolean columnExists(Connection conn,
                            String table,
                            String column,
                            Object value)
                     throws DataAccessException

Throws:

DataAccessException

tableHasColumn

public boolean tableHasColumn(Connection conn,
                              String table,
                              String column)
                       throws DataAccessException

Throws:

DataAccessException

tableExists

public boolean tableExists(Connection conn,
                           String table)
                    throws DataAccessException

Throws:

DataAccessException

buildCreateSequenceSql

protected abstract String buildCreateSequenceSql(String sequenceName,
                                                 long startValue)

buildDropSequenceSql

protected abstract String buildDropSequenceSql(String sequenceName)

buildNextSeqValueSql

protected abstract String buildNextSeqValueSql(String sequenceName)

buildAndCacheNextSeqValueSql

protected final String buildAndCacheNextSeqValueSql(String sequenceName)

isUseSqlStateAsCode

protected boolean isUseSqlStateAsCode()

dropAndCreateSequence

public void dropAndCreateSequence(String sequenceName,
                                  long startValue)
                           throws DataAccessException

Throws:

DataAccessException

createSequence

public void createSequence(String sequenceName,
                           long startValue)
                    throws DataAccessException

Throws:

DataAccessException

dropSequence

public void dropSequence(String sequenceName)
                  throws DataAccessException

Throws:

DataAccessException

setLastUsedSeqValue

public void setLastUsedSeqValue(String sequenceName,
                                long sequenceValue)

nextSeqValue

public long nextSeqValue(Connection conn,
                         String sequenceName)
                  throws DataAccessException

Throws:

DataAccessException

getSqlToDropPrimaryKey

protected String getSqlToDropPrimaryKey(String primaryKeyName,
                                        String table)

dropPrimaryKey

public void dropPrimaryKey(Connection conn,
                           String primaryKeyName,
                           String table)
                    throws DataAccessException

Throws:

DataAccessException

getSqlToAddPrimaryKey

protected String getSqlToAddPrimaryKey(String primaryKeyName,
                                       String table,
                                       String... columns)

addPrimaryKey

public void addPrimaryKey(Connection conn,
                          String primaryKeyName,
                          String table,
                          String... columns)
                   throws DataAccessException

Throws:

DataAccessException

getSqlToDropForeignKeyConstraint

protected String getSqlToDropForeignKeyConstraint(String constraintName,
                                                  String baseTable)
                                           throws DataAccessException

Throws:

DataAccessException

dropForeignKeyConstraint

public void dropForeignKeyConstraint(Connection conn,
                                     String constraintName,
                                     String baseTable)
                              throws DataAccessException

Throws:

DataAccessException

getSqlToAddForeignKeyConstraint

protected String getSqlToAddForeignKeyConstraint(String constraintName,
                                                 String baseTable,
                                                 String baseColumn,
                                                 String referencedTable,
                                                 String referencedColumn,
                                                 String onDeleteAction,
                                                 String onUpdateAction)

addForeignKeyConstraint

public void addForeignKeyConstraint(Connection conn,
                                    String constraintName,
                                    String baseTable,
                                    String baseColumn,
                                    String referencedTable,
                                    String referencedColumn,
                                    String onDeleteAction,
                                    String onUpdateAction)
                             throws DataAccessException

Throws:

DataAccessException

getSqlToDropIndex

protected String getSqlToDropIndex(String table,
                                   String indexName)

dropIndex

public void dropIndex(Connection conn,
                      String table,
                      String indexName)
               throws DataAccessException

Throws:

DataAccessException

getSqlToCreateIndex

protected String getSqlToCreateIndex(String indexName,
                                     String table,
                                     String... columns)

createIndex

public void createIndex(Connection conn,
                        String indexName,
                        String table,
                        String... columns)
                 throws DataAccessException

Throws:

DataAccessException

getSqlToDropUniqueConstraint

protected String getSqlToDropUniqueConstraint(String constraintName,
                                              String table)

dropUniqueConstrain

public void dropUniqueConstrain(Connection conn,
                                String constraintName,
                                String table)
                         throws DataAccessException

Throws:

DataAccessException

getSqlToAddUniqueConstrain

protected String getSqlToAddUniqueConstrain(String constraintName,
                                            String table,
                                            String... columns)

addUniqueConstrain

public void addUniqueConstrain(Connection conn,
                               String constraintName,
                               String table,
                               String... columns)
                        throws DataAccessException

Throws:

DataAccessException

translate

public DataAccessException translate(String sql,
                                     SQLException ex)