to.etc.dbpool

Class ConnectionProxy

java.lang.Object

to.etc.dbpool.ConnectionProxy

All Implemented Interfaces:

AutoCloseable, Connection, Wrapper

public final class ConnectionProxy
extends Object
implements Connection

This "implements" Connection, and is a proxy to the actual connection maintained in ConnectionPoolEntry. An instance is created every time a connection is allocated from the pool and returned to the user. This instance is never reused and becomes invalid after close() is called on it.

This also contains all of the data associated with a connection, for debugging, logging and statistics gathering. Most of the data herein is locked by this. FIXME Must implement java.sql.PooledConnection.

Author:

Frits Jalvingh Created on Nov 2, 2010

Field Summary

Fields inherited from interface java.sql.Connection

TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE

Method Summary

Modifier and Type	Method and Description
void	abort(Executor executor)
void	addCommitListener(IDatabaseEventListener c) Add a commit-time listener to this connection.
void	addOwnerInfo(Object oo) Adds owner info objects to the connection.
void	checkHangState(to.etc.dbpool.HangCheckState hs) Called without any locks to see if this connection is a "hanging" connection.
void	clearWarnings()
void	close() The "normal" close releases all resources associated with this connection by closing them, then it returns the connection to the pool.
void	commit() Commit proxies to the real connection, but also handles the "disable commits" per-thread option that can be set by ConnectionPool.setCommitDisabled(boolean) and the commit-time listeners that can be added by addCommitListener(IDatabaseEventListener).
Array	createArrayOf(String arg0, Object[] arg1)
Blob	createBlob()
Clob	createClob()
NClob	createNClob()
SQLXML	createSQLXML()
Statement	createStatement()
Statement	createStatement(int p1, int p2)
Statement	createStatement(int p1, int p2, int p3)
Struct	createStruct(String arg0, Object[] arg1)
void	forceClosed() Actually closes a proxy, if not already done.
Tracepoint	getAllocationPoint()
long	getAllocationTime() Return the immutable allocation time.
boolean	getAutoCommit()
String	getCatalog()
Properties	getClientInfo()
String	getClientInfo(String arg0)
Tracepoint	getCloseLocation()
int	getHoldability()
int	getId()
long	getLastUsedTime() Return the time this was last used.
DatabaseMetaData	getMetaData()
int	getNetworkTimeout()
Thread	getOwnerThread()
ConnectionPool	getPool()
String	getPoolID()
Connection	getRealConnection() Returns the REAL database connection (the one obtained from the JDBC driver) for this proxy.
String	getSchema()
ConnState	getState()
List<Tracepoint>	getTraceList() Return the list of tracepoints, from old to new.
int	getTransactionIsolation()
Map	getTypeMap()
SQLWarning	getWarnings()
boolean	isClosed()
boolean	isReadOnly()
boolean	isUnpooled() THIS MAY ONLY LOCK THIS AND MUST BE IMMUTABLE.
boolean	isValid(int arg0)
boolean	isWrapperFor(Class<?> iface)
String	nativeSQL(String p1)
CallableStatement	prepareCall(String p1)
CallableStatement	prepareCall(String p1, int p2, int p3)
CallableStatement	prepareCall(String name, int a, int b, int c)
PreparedStatement	prepareStatement(String p1)
PreparedStatement	prepareStatement(String p1, int p2)
PreparedStatement	prepareStatement(String p1, int[] p2)
PreparedStatement	prepareStatement(String p1, int p2, int p3)
PreparedStatement	prepareStatement(String p1, int p2, int p3, int p4)
PreparedStatement	prepareStatement(String a, String[] ar)
void	releaseSavepoint(Savepoint sp)
void	removeCommitListener(IDatabaseEventListener c) Remove an earlier registered commit listener - silly usage, questionable interface.
protected void	removeResource(Object o) This removes the resource from the resource list because it was normally closed.
void	rollback()
void	rollback(Savepoint sp)
void	setAutoCommit(boolean p1)
void	setCatalog(String p1)
void	setClientInfo(Properties arg0)
void	setClientInfo(String arg0, String arg1)
void	setHoldability(int m)
void	setNetworkTimeout(Executor executor, int milliseconds)
void	setReadOnly(boolean p1)
Savepoint	setSavepoint()
Savepoint	setSavepoint(String name)
void	setSchema(String schema)
void	setTransactionIsolation(int p1)
void	setTypeMap(Map p1)
void	setUncloseable(boolean unclosable) Forbid a connection from being closed using the normal close() method.
protected to.etc.dbpool.IConnectionEventListener	statsHandler()
String	toString()
<T> T	unwrap(Class<T> iface)

Methods inherited from class java.lang.Object

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

Method Detail

getAllocationTime

public long getAllocationTime()

Return the immutable allocation time.

Returns:

getAllocationPoint

public Tracepoint getAllocationPoint()

getOwnerThread

public Thread getOwnerThread()

getPoolID

public String getPoolID()

getId

public int getId()

statsHandler

@Nonnull
protected to.etc.dbpool.IConnectionEventListener statsHandler()

getPool

public ConnectionPool getPool()

isUnpooled

public final boolean isUnpooled()

THIS MAY ONLY LOCK THIS AND MUST BE IMMUTABLE.

Returns:

toString

public String toString()

Overrides:

toString in class Object

addOwnerInfo

public void addOwnerInfo(Object oo)

Adds owner info objects to the connection. These will be rendered at debug time, when needed.

Parameters:

oo -

getState

public ConnState getState()

getRealConnection

public Connection getRealConnection()

Returns the REAL database connection (the one obtained from the JDBC driver) for this proxy. LOCKS THIS.

Returns:

the connection

close

public void close()
           throws SQLException

The "normal" close releases all resources associated with this connection by closing them, then it returns the connection to the pool. If the connection is already closed then nothing happens (multiple closes are allowed). LOCKS THIS. THIS CALL MAY ONLY BE CALLED BY USER CODE, NOT BY POOL CODE!!!

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Connection

Throws:

SQLException

forceClosed

public void forceClosed()
                 throws SQLException

Actually closes a proxy, if not already done. This also sets the close reason and location. This can be called from pool code. Can be called for connections that ignore the normal close operation to force the proxy closed. The connection is returned to the pool proper.

Throws:

SQLException

commit

public void commit()
            throws SQLException

Commit proxies to the real connection, but also handles the "disable commits" per-thread option that can be set by ConnectionPool.setCommitDisabled(boolean) and the commit-time listeners that can be added by addCommitListener(IDatabaseEventListener).

Specified by:

commit in interface Connection

Throws:

SQLException

getTraceList

public List<Tracepoint> getTraceList()

Return the list of tracepoints, from old to new. The first entry is always the allocation point. If stacktracing is disabled this returns the allocation point only (and the close point if known). This is valid even when the connection is closed/invalidated or whatnot. LOCKS THIS.

Returns:

getCloseLocation

@Nullable
public Tracepoint getCloseLocation()

getLastUsedTime

public long getLastUsedTime()

Return the time this was last used.

Returns:

checkHangState

public void checkHangState(to.etc.dbpool.HangCheckState hs)

Called without any locks to see if this connection is a "hanging" connection. This is racy by definition because no locks are maintained. It means that the connection's state can change during the process while locks are clear. This means that all parts of this process must accept a state transition from life to dead at any time. Because proxies are single-use only they cannot be resurrected, so when it is determined they are dead the process can quit immediately.

Determining hang state

Unpooled connections have their hang state checked using a staggered time interval. They are never cleared unless we are in "urgent" mode.

Longliving connections are not checked using staggered time interval. They are never cleared unless we are in "urgent" mode.

Parameters:

hs -

removeResource

protected void removeResource(Object o)

This removes the resource from the resource list because it was normally closed.

Parameters:

o - the resource to remove.

setUncloseable

public void setUncloseable(boolean unclosable)

Forbid a connection from being closed using the normal close() method.

addCommitListener

public void addCommitListener(@Nonnull
                              IDatabaseEventListener c)

Add a commit-time listener to this connection. The listener is called after the 1st commit; the list is cleared at that time (provided the commit works).

Parameters:

c -

Since:

2011/08/12

removeCommitListener

public void removeCommitListener(@Nonnull
                                 IDatabaseEventListener c)

Remove an earlier registered commit listener - silly usage, questionable interface.

Parameters:

c -

Since:

2011/08/12

prepareStatement

public PreparedStatement prepareStatement(String p1)
                                   throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

public PreparedStatement prepareStatement(String p1,
                                          int[] p2)
                                   throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

public PreparedStatement prepareStatement(String p1,
                                          int p2)
                                   throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

public PreparedStatement prepareStatement(String p1,
                                          int p2,
                                          int p3)
                                   throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

public PreparedStatement prepareStatement(String p1,
                                          int p2,
                                          int p3,
                                          int p4)
                                   throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareCall

public CallableStatement prepareCall(String name,
                                     int a,
                                     int b,
                                     int c)
                              throws SQLException

Specified by:

prepareCall in interface Connection

Throws:

SQLException

prepareStatement

public PreparedStatement prepareStatement(String a,
                                          String[] ar)
                                   throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

createStatement

public Statement createStatement()
                          throws SQLException

Specified by:

createStatement in interface Connection

Throws:

SQLException

createStatement

public Statement createStatement(int p1,
                                 int p2)
                          throws SQLException

Specified by:

createStatement in interface Connection

Throws:

SQLException

createStatement

public Statement createStatement(int p1,
                                 int p2,
                                 int p3)
                          throws SQLException

Specified by:

createStatement in interface Connection

Throws:

SQLException

prepareCall

public CallableStatement prepareCall(String p1,
                                     int p2,
                                     int p3)
                              throws SQLException

Specified by:

prepareCall in interface Connection

Throws:

SQLException

prepareCall

public CallableStatement prepareCall(String p1)
                              throws SQLException

Specified by:

prepareCall in interface Connection

Throws:

SQLException

setCatalog

public void setCatalog(String p1)
                throws SQLException

Specified by:

setCatalog in interface Connection

Throws:

SQLException

rollback

public void rollback()
              throws SQLException

Specified by:

rollback in interface Connection

Throws:

SQLException

clearWarnings

public void clearWarnings()
                   throws SQLException

Specified by:

clearWarnings in interface Connection

Throws:

SQLException

getTypeMap

public Map getTypeMap()
               throws SQLException

Specified by:

getTypeMap in interface Connection

Throws:

SQLException

getTransactionIsolation

public int getTransactionIsolation()
                            throws SQLException

Specified by:

getTransactionIsolation in interface Connection

Throws:

SQLException

setTransactionIsolation

public void setTransactionIsolation(int p1)
                             throws SQLException

Specified by:

setTransactionIsolation in interface Connection

Throws:

SQLException

isClosed

public boolean isClosed()
                 throws SQLException

Specified by:

isClosed in interface Connection

Throws:

SQLException

setAutoCommit

public void setAutoCommit(boolean p1)
                   throws SQLException

Specified by:

setAutoCommit in interface Connection

Throws:

SQLException

getCatalog

public String getCatalog()
                  throws SQLException

Specified by:

getCatalog in interface Connection

Throws:

SQLException

isReadOnly

public boolean isReadOnly()
                   throws SQLException

Specified by:

isReadOnly in interface Connection

Throws:

SQLException

getMetaData

public DatabaseMetaData getMetaData()
                             throws SQLException

Specified by:

getMetaData in interface Connection

Throws:

SQLException

setReadOnly

public void setReadOnly(boolean p1)
                 throws SQLException

Specified by:

setReadOnly in interface Connection

Throws:

SQLException

getAutoCommit

public boolean getAutoCommit()
                      throws SQLException

Specified by:

getAutoCommit in interface Connection

Throws:

SQLException

nativeSQL

public String nativeSQL(String p1)
                 throws SQLException

Specified by:

nativeSQL in interface Connection

Throws:

SQLException

setTypeMap

public void setTypeMap(Map p1)
                throws SQLException

Specified by:

setTypeMap in interface Connection

Throws:

SQLException

getWarnings

public SQLWarning getWarnings()
                       throws SQLException

Specified by:

getWarnings in interface Connection

Throws:

SQLException

releaseSavepoint

public void releaseSavepoint(Savepoint sp)
                      throws SQLException

Specified by:

releaseSavepoint in interface Connection

Throws:

SQLException

rollback

public void rollback(Savepoint sp)
              throws SQLException

Specified by:

rollback in interface Connection

Throws:

SQLException

setSavepoint

public Savepoint setSavepoint(String name)
                       throws SQLException

Specified by:

setSavepoint in interface Connection

Throws:

SQLException

setSavepoint

public Savepoint setSavepoint()
                       throws SQLException

Specified by:

setSavepoint in interface Connection

Throws:

SQLException

getHoldability

public int getHoldability()
                   throws SQLException

Specified by:

getHoldability in interface Connection

Throws:

SQLException

setHoldability

public void setHoldability(int m)
                    throws SQLException

Specified by:

setHoldability in interface Connection

Throws:

SQLException

createArrayOf

public Array createArrayOf(String arg0,
                           Object[] arg1)
                    throws SQLException

Specified by:

createArrayOf in interface Connection

Throws:

SQLException

createBlob

public Blob createBlob()
                throws SQLException

Specified by:

createBlob in interface Connection

Throws:

SQLException

createClob

public Clob createClob()
                throws SQLException

Specified by:

createClob in interface Connection

Throws:

SQLException

createNClob

public NClob createNClob()
                  throws SQLException

Specified by:

createNClob in interface Connection

Throws:

SQLException

createSQLXML

public SQLXML createSQLXML()
                    throws SQLException

Specified by:

createSQLXML in interface Connection

Throws:

SQLException

createStruct

public Struct createStruct(String arg0,
                           Object[] arg1)
                    throws SQLException

Specified by:

createStruct in interface Connection

Throws:

SQLException

getClientInfo

public Properties getClientInfo()
                         throws SQLException

Specified by:

getClientInfo in interface Connection

Throws:

SQLException

getClientInfo

public String getClientInfo(String arg0)
                     throws SQLException

Specified by:

getClientInfo in interface Connection

Throws:

SQLException

isValid

public boolean isValid(int arg0)
                throws SQLException

Specified by:

isValid in interface Connection

Throws:

SQLException

isWrapperFor

public boolean isWrapperFor(Class<?> iface)
                     throws SQLException

Specified by:

isWrapperFor in interface Wrapper

Throws:

SQLException

setClientInfo

public void setClientInfo(Properties arg0)
                   throws SQLClientInfoException

Specified by:

setClientInfo in interface Connection

Throws:

SQLClientInfoException

setClientInfo

public void setClientInfo(String arg0,
                          String arg1)
                   throws SQLClientInfoException

Specified by:

setClientInfo in interface Connection

Throws:

SQLClientInfoException

unwrap

public <T> T unwrap(Class<T> iface)
             throws SQLException

Specified by:

unwrap in interface Wrapper

Throws:

SQLException

setSchema

public void setSchema(String schema)
               throws SQLException

Specified by:

setSchema in interface Connection

Throws:

SQLException

getSchema

public String getSchema()
                 throws SQLException

Specified by:

getSchema in interface Connection

Throws:

SQLException

abort

public void abort(Executor executor)
           throws SQLException

Specified by:

abort in interface Connection

Throws:

SQLException

setNetworkTimeout

public void setNetworkTimeout(Executor executor,
                              int milliseconds)
                       throws SQLException

Specified by:

setNetworkTimeout in interface Connection

Throws:

SQLException

getNetworkTimeout

public int getNetworkTimeout()
                      throws SQLException

Specified by:

getNetworkTimeout in interface Connection

Throws:

SQLException