Package org.apache.openjpa.lib.jdbc
Class DelegatingConnection
- java.lang.Object
-
- org.apache.openjpa.lib.jdbc.DelegatingConnection
-
- All Implemented Interfaces:
AutoCloseable,Connection,Wrapper,Closeable
- Direct Known Subclasses:
ConfiguringConnectionDecorator.ConfiguringConnection,JDBCStoreManager.ClientConnection,JDBCStoreManager.RefCountConnection,LoggingConnectionDecorator.LoggingConnection,PostgresDictionary.PostgresConnection,SybaseDictionary.SybaseConnection
public class DelegatingConnection extends Object implements Connection, Closeable
Wrapper around an existing connection. Subclasses can override the methods whose behavior they mean to change. TheequalsandhashCodemethods pass through to the base underlying data store connection.- Author:
- Abe White
-
-
Field Summary
-
Fields inherited from interface java.sql.Connection
TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE
-
-
Constructor Summary
Constructors Constructor Description DelegatingConnection(Connection conn)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidabort(Executor executor)protected voidappendInfo(StringBuffer buf)voidclearWarnings()voidclose()voidcommit()ArraycreateArrayOf(String typeName, Object[] elements)BlobcreateBlob()ClobcreateClob()NClobcreateNClob()SQLXMLcreateSQLXML()StatementcreateStatement()protected StatementcreateStatement(boolean wrap)Create a statement, with the option of not wrapping it in aDelegatingStatement, which is the default.StatementcreateStatement(int type, int concur)protected StatementcreateStatement(int type, int concur, boolean wrap)Create a statement, with the option of not wrapping it in aDelegatingStatement, which is the default.StatementcreateStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability)protected StatementcreateStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability, boolean wrap)StructcreateStruct(String typeName, Object[] attributes)booleanequals(Object other)booleangetAutoCommit()StringgetCatalog()PropertiesgetClientInfo()StringgetClientInfo(String name)ConnectiongetDelegate()Return the wrapped connection.intgetHoldability()ConnectiongetInnermostDelegate()Return the base underlying data store connection.DatabaseMetaDatagetMetaData()protected DatabaseMetaDatagetMetaData(boolean wrap)Return the metadata, with the option of not wrapping it in aDelegatingDatabaseMetaData, which is the default.intgetNetworkTimeout()StringgetSchema()intgetTransactionIsolation()Map<String,Class<?>>getTypeMap()SQLWarninggetWarnings()inthashCode()booleanisClosed()booleanisReadOnly()booleanisValid(int timeout)booleanisWrapperFor(Class<?> iface)StringnativeSQL(String str)CallableStatementprepareCall(String str)protected CallableStatementprepareCall(String str, boolean wrap)Prepare a call, with the option of not wrapping it in aDelegatingCallableStatement, which is the default.CallableStatementprepareCall(String str, int type, int concur)protected CallableStatementprepareCall(String str, int type, int concur, boolean wrap)Prepare a call, with the option of not wrapping it in aDelegatingCallableStatement, which is the default.CallableStatementprepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)protected CallableStatementprepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability, boolean wrap)PreparedStatementprepareStatement(String str)protected PreparedStatementprepareStatement(String str, boolean wrap)Prepare a statement, with the option of not wrapping it in aDelegatingPreparedStatement, which is the default.PreparedStatementprepareStatement(String sql, int autoGeneratedKeys)PreparedStatementprepareStatement(String sql, int[] columnIndexes)protected PreparedStatementprepareStatement(String sql, int[] columnIndexes, boolean wrap)protected PreparedStatementprepareStatement(String sql, int autoGeneratedKeys, boolean wrap)PreparedStatementprepareStatement(String str, int type, int concur)protected PreparedStatementprepareStatement(String str, int type, int concur, boolean wrap)Prepare a statement, with the option of not wrapping it in aDelegatingPreparedStatement, which is the default.PreparedStatementprepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)protected PreparedStatementprepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability, boolean wrap)PreparedStatementprepareStatement(String sql, String[] columnNames)protected PreparedStatementprepareStatement(String sql, String[] columnNames, boolean wrap)voidreleaseSavepoint(Savepoint savepoint)voidrollback()voidrollback(Savepoint savepoint)voidsetAutoCommit(boolean bool)voidsetCatalog(String str)voidsetClientInfo(String name, String value)voidsetClientInfo(Properties properties)voidsetHoldability(int holdability)voidsetNetworkTimeout(Executor executor, int milliseconds)voidsetReadOnly(boolean bool)SavepointsetSavepoint()SavepointsetSavepoint(String savepoint)voidsetSchema(String schema)voidsetTransactionIsolation(int i)voidsetTypeMap(Map<String,Class<?>> map)StringtoString()<T> Tunwrap(Class<T> iface)From java.sql.Wrapper javadoc: Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.sql.Connection
beginRequest, endRequest, setShardingKey, setShardingKey, setShardingKeyIfValid, setShardingKeyIfValid
-
-
-
-
Constructor Detail
-
DelegatingConnection
public DelegatingConnection(Connection conn)
-
-
Method Detail
-
getDelegate
public Connection getDelegate()
Return the wrapped connection.
-
getInnermostDelegate
public Connection getInnermostDelegate()
Return the base underlying data store connection.
-
appendInfo
protected void appendInfo(StringBuffer buf)
-
createStatement
public Statement createStatement() throws SQLException
- Specified by:
createStatementin interfaceConnection- Throws:
SQLException
-
createStatement
protected Statement createStatement(boolean wrap) throws SQLException
Create a statement, with the option of not wrapping it in aDelegatingStatement, which is the default.- Throws:
SQLException
-
prepareStatement
public PreparedStatement prepareStatement(String str) throws SQLException
- Specified by:
prepareStatementin interfaceConnection- Throws:
SQLException
-
prepareStatement
protected PreparedStatement prepareStatement(String str, boolean wrap) throws SQLException
Prepare a statement, with the option of not wrapping it in aDelegatingPreparedStatement, which is the default.- Throws:
SQLException
-
prepareCall
public CallableStatement prepareCall(String str) throws SQLException
- Specified by:
prepareCallin interfaceConnection- Throws:
SQLException
-
prepareCall
protected CallableStatement prepareCall(String str, boolean wrap) throws SQLException
Prepare a call, with the option of not wrapping it in aDelegatingCallableStatement, which is the default.- Throws:
SQLException
-
nativeSQL
public String nativeSQL(String str) throws SQLException
- Specified by:
nativeSQLin interfaceConnection- Throws:
SQLException
-
setAutoCommit
public void setAutoCommit(boolean bool) throws SQLException- Specified by:
setAutoCommitin interfaceConnection- Throws:
SQLException
-
getAutoCommit
public boolean getAutoCommit() throws SQLException- Specified by:
getAutoCommitin interfaceConnection- Throws:
SQLException
-
commit
public void commit() throws SQLException- Specified by:
commitin interfaceConnection- Throws:
SQLException
-
rollback
public void rollback() throws SQLException- Specified by:
rollbackin interfaceConnection- Throws:
SQLException
-
close
public void close() throws SQLException- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Specified by:
closein interfaceConnection- Throws:
SQLException
-
isClosed
public boolean isClosed() throws SQLException- Specified by:
isClosedin interfaceConnection- Throws:
SQLException
-
getMetaData
public DatabaseMetaData getMetaData() throws SQLException
- Specified by:
getMetaDatain interfaceConnection- Throws:
SQLException
-
getMetaData
protected DatabaseMetaData getMetaData(boolean wrap) throws SQLException
Return the metadata, with the option of not wrapping it in aDelegatingDatabaseMetaData, which is the default.- Throws:
SQLException
-
setReadOnly
public void setReadOnly(boolean bool) throws SQLException- Specified by:
setReadOnlyin interfaceConnection- Throws:
SQLException
-
isReadOnly
public boolean isReadOnly() throws SQLException- Specified by:
isReadOnlyin interfaceConnection- Throws:
SQLException
-
setCatalog
public void setCatalog(String str) throws SQLException
- Specified by:
setCatalogin interfaceConnection- Throws:
SQLException
-
getCatalog
public String getCatalog() throws SQLException
- Specified by:
getCatalogin interfaceConnection- Throws:
SQLException
-
setTransactionIsolation
public void setTransactionIsolation(int i) throws SQLException- Specified by:
setTransactionIsolationin interfaceConnection- Throws:
SQLException
-
getTransactionIsolation
public int getTransactionIsolation() throws SQLException- Specified by:
getTransactionIsolationin interfaceConnection- Throws:
SQLException
-
getWarnings
public SQLWarning getWarnings() throws SQLException
- Specified by:
getWarningsin interfaceConnection- Throws:
SQLException
-
clearWarnings
public void clearWarnings() throws SQLException- Specified by:
clearWarningsin interfaceConnection- Throws:
SQLException
-
createStatement
public Statement createStatement(int type, int concur) throws SQLException
- Specified by:
createStatementin interfaceConnection- Throws:
SQLException
-
createStatement
protected Statement createStatement(int type, int concur, boolean wrap) throws SQLException
Create a statement, with the option of not wrapping it in aDelegatingStatement, which is the default.- Throws:
SQLException
-
prepareStatement
public PreparedStatement prepareStatement(String str, int type, int concur) throws SQLException
- Specified by:
prepareStatementin interfaceConnection- Throws:
SQLException
-
prepareStatement
protected PreparedStatement prepareStatement(String str, int type, int concur, boolean wrap) throws SQLException
Prepare a statement, with the option of not wrapping it in aDelegatingPreparedStatement, which is the default.- Throws:
SQLException
-
prepareCall
public CallableStatement prepareCall(String str, int type, int concur) throws SQLException
- Specified by:
prepareCallin interfaceConnection- Throws:
SQLException
-
prepareCall
protected CallableStatement prepareCall(String str, int type, int concur, boolean wrap) throws SQLException
Prepare a call, with the option of not wrapping it in aDelegatingCallableStatement, which is the default.- Throws:
SQLException
-
getTypeMap
public Map<String,Class<?>> getTypeMap() throws SQLException
- Specified by:
getTypeMapin interfaceConnection- Throws:
SQLException
-
setTypeMap
public void setTypeMap(Map<String,Class<?>> map) throws SQLException
- Specified by:
setTypeMapin interfaceConnection- Throws:
SQLException
-
setHoldability
public void setHoldability(int holdability) throws SQLException- Specified by:
setHoldabilityin interfaceConnection- Throws:
SQLException
-
getHoldability
public int getHoldability() throws SQLException- Specified by:
getHoldabilityin interfaceConnection- Throws:
SQLException
-
setSavepoint
public Savepoint setSavepoint() throws SQLException
- Specified by:
setSavepointin interfaceConnection- Throws:
SQLException
-
setSavepoint
public Savepoint setSavepoint(String savepoint) throws SQLException
- Specified by:
setSavepointin interfaceConnection- Throws:
SQLException
-
rollback
public void rollback(Savepoint savepoint) throws SQLException
- Specified by:
rollbackin interfaceConnection- Throws:
SQLException
-
releaseSavepoint
public void releaseSavepoint(Savepoint savepoint) throws SQLException
- Specified by:
releaseSavepointin interfaceConnection- Throws:
SQLException
-
createStatement
public Statement createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException
- Specified by:
createStatementin interfaceConnection- Throws:
SQLException
-
createStatement
protected Statement createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability, boolean wrap) throws SQLException
- Throws:
SQLException
-
prepareStatement
public PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException
- Specified by:
prepareStatementin interfaceConnection- Throws:
SQLException
-
prepareStatement
protected PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability, boolean wrap) throws SQLException
- Throws:
SQLException
-
prepareCall
public CallableStatement prepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException
- Specified by:
prepareCallin interfaceConnection- Throws:
SQLException
-
prepareCall
protected CallableStatement prepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability, boolean wrap) throws SQLException
- Throws:
SQLException
-
prepareStatement
public PreparedStatement prepareStatement(String sql, int autoGeneratedKeys) throws SQLException
- Specified by:
prepareStatementin interfaceConnection- Throws:
SQLException
-
prepareStatement
protected PreparedStatement prepareStatement(String sql, int autoGeneratedKeys, boolean wrap) throws SQLException
- Throws:
SQLException
-
prepareStatement
public PreparedStatement prepareStatement(String sql, int[] columnIndexes) throws SQLException
- Specified by:
prepareStatementin interfaceConnection- Throws:
SQLException
-
prepareStatement
protected PreparedStatement prepareStatement(String sql, int[] columnIndexes, boolean wrap) throws SQLException
- Throws:
SQLException
-
prepareStatement
public PreparedStatement prepareStatement(String sql, String[] columnNames) throws SQLException
- Specified by:
prepareStatementin interfaceConnection- Throws:
SQLException
-
prepareStatement
protected PreparedStatement prepareStatement(String sql, String[] columnNames, boolean wrap) throws SQLException
- Throws:
SQLException
-
isWrapperFor
public boolean isWrapperFor(Class<?> iface) throws SQLException
- Specified by:
isWrapperForin interfaceWrapper- Throws:
SQLException
-
unwrap
public <T> T unwrap(Class<T> iface) throws SQLException
From java.sql.Wrapper javadoc: Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy. If the receiver implements the interface then the result is the receiver or a proxy for the receiver. If the receiver is a wrapper and the wrapped object implements the interface then the result is the wrapped object or a proxy for the wrapped object. Otherwise return the the result of calling unwrap recursively on the wrapped object or a proxy for that result. If the receiver is not a wrapper and does not implement the interface, then an SQLException is thrown.- Specified by:
unwrapin interfaceWrapper- Throws:
SQLException
-
createArrayOf
public Array createArrayOf(String typeName, Object[] elements) throws SQLException
- Specified by:
createArrayOfin interfaceConnection- Throws:
SQLException
-
createBlob
public Blob createBlob() throws SQLException
- Specified by:
createBlobin interfaceConnection- Throws:
SQLException
-
createClob
public Clob createClob() throws SQLException
- Specified by:
createClobin interfaceConnection- Throws:
SQLException
-
createNClob
public NClob createNClob() throws SQLException
- Specified by:
createNClobin interfaceConnection- Throws:
SQLException
-
createSQLXML
public SQLXML createSQLXML() throws SQLException
- Specified by:
createSQLXMLin interfaceConnection- Throws:
SQLException
-
createStruct
public Struct createStruct(String typeName, Object[] attributes) throws SQLException
- Specified by:
createStructin interfaceConnection- Throws:
SQLException
-
getClientInfo
public Properties getClientInfo() throws SQLException
- Specified by:
getClientInfoin interfaceConnection- Throws:
SQLException
-
getClientInfo
public String getClientInfo(String name) throws SQLException
- Specified by:
getClientInfoin interfaceConnection- Throws:
SQLException
-
isValid
public boolean isValid(int timeout) throws SQLException- Specified by:
isValidin interfaceConnection- Throws:
SQLException
-
setClientInfo
public void setClientInfo(Properties properties) throws SQLClientInfoException
- Specified by:
setClientInfoin interfaceConnection- Throws:
SQLClientInfoException
-
setClientInfo
public void setClientInfo(String name, String value) throws SQLClientInfoException
- Specified by:
setClientInfoin interfaceConnection- Throws:
SQLClientInfoException
-
abort
public void abort(Executor executor) throws SQLException
- Specified by:
abortin interfaceConnection- Throws:
SQLException
-
getNetworkTimeout
public int getNetworkTimeout() throws SQLException- Specified by:
getNetworkTimeoutin interfaceConnection- Throws:
SQLException
-
setNetworkTimeout
public void setNetworkTimeout(Executor executor, int milliseconds) throws SQLException
- Specified by:
setNetworkTimeoutin interfaceConnection- Throws:
SQLException
-
getSchema
public String getSchema() throws SQLException
- Specified by:
getSchemain interfaceConnection- Throws:
SQLException
-
setSchema
public void setSchema(String schema) throws SQLException
- Specified by:
setSchemain interfaceConnection- Throws:
SQLException
-
-