Class DisposableConnectionFacade

java.lang.Object

org.apache.tomcat.jdbc.pool.JdbcInterceptor

org.apache.tomcat.jdbc.pool.DisposableConnectionFacade

All Implemented Interfaces:

InvocationHandler

public class DisposableConnectionFacade
extends JdbcInterceptor

A DisposableConnectionFacade object is the top most interceptor that wraps an object of type PooledConnection. The DisposableConnectionFacade intercepts three methods:

• Connection.close() - breaks the link between cutoff and the next interceptor, then returns the connection to the pool. May be called multiple times.
• Connection.abort(java.util.concurrent.Executor) - disposes of the facade in the same way, then delegates the abort to the chain, which ends the borrow. A facade already disposed answers the call with the no-op the JDBC specification prescribes for a closed connection.
• Object.toString() - returns a custom string for this object

By default method comparisons is done on a String reference level, unless the PoolConfiguration.setUseEquals(boolean) has been called with a true argument.

Field Summary

Fields inherited from class JdbcInterceptor

ABORT_VAL, CLOSE_VAL, EQUALS_VAL, GETCONNECTION_VAL, HASHCODE_VAL, ISCLOSED_VAL, ISVALID_VAL, ISWRAPPERFOR_VAL, properties, TOSTRING_VAL, UNWRAP_VAL

Modifier and Type	Field	Description
static final String	ABORT_VAL	Connection.abort(java.util.concurrent.Executor) method name
static final String	CLOSE_VAL	Connection.close() method name
static final String	EQUALS_VAL	Object.equals(Object)
static final String	GETCONNECTION_VAL	PooledConnection.getConnection() method name
static final String	HASHCODE_VAL	Object.hashCode()
static final String	ISCLOSED_VAL	Connection.isClosed() method name
static final String	ISVALID_VAL	Connection.isValid(int) method name
static final String	ISWRAPPERFOR_VAL	Wrapper.isWrapperFor(Class) method name
protected Map<String, PoolProperties.InterceptorProperty>	properties	Properties for this interceptor.
static final String	TOSTRING_VAL	Object.toString() method name
static final String	UNWRAP_VAL	Wrapper.unwrap(Class) method name

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DisposableConnectionFacade(JdbcInterceptor interceptor)	Construct a DisposableConnectionFacade that wraps the given interceptor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
int	hashCode()
Object	invoke(Object proxy, Method method, Object[] args)	Gets invoked each time an operation on Connection is invoked.
void	reset(ConnectionPool parent, PooledConnection con)	Gets called each time the connection is borrowed from the pool This means that if an interceptor holds a reference to the connection the interceptor can be reused for another connection.

Methods inherited from class JdbcInterceptor

compare, compare, disconnected, getNext, getProperties, isUseEquals, poolClosed, poolStarted, setNext, setProperties, setUseEquals

Modifier and Type	Method	Description
boolean	compare(String methodName, Method method)	Compares a method name (String) to a method (Method) JdbcInterceptor.compare(String,String) Uses reference comparison unless the useEquals property is set to true
boolean	compare(String name1, String name2)	Performs a string comparison, using references unless the useEquals property is set to true.
void	disconnected(ConnectionPool parent, PooledConnection con, boolean finalizing)	Called when Connection.close() is called on the underlying connection.
JdbcInterceptor	getNext()	Returns the next interceptor in the chain
Map<String, PoolProperties.InterceptorProperty>	getProperties()	Returns the properties configured for this interceptor
boolean	isUseEquals()	True if the compare method uses the Object.equals(Object) method, false if comparison is done on a reference level.
void	poolClosed(ConnectionPool pool)	This method is invoked by a connection pool when the pool is closed.
void	poolStarted(ConnectionPool pool)	This method is invoked by a connection pool when the pool is first started up, usually when the first connection is requested.
void	setNext(JdbcInterceptor next)	configures the next interceptor in the chain
void	setProperties(Map<String, PoolProperties.InterceptorProperty> properties)	Called during the creation of an interceptor The properties can be set during the configuration of an interceptor Override this method to perform type casts between string values and object properties
void	setUseEquals(boolean useEquals)	Set to true if string comparisons (for the JdbcInterceptor.compare(String, Method) and JdbcInterceptor.compare(String, String) methods) should use the Object.equals(Object) method The default is false

Methods inherited from class Object

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

Constructor Details

DisposableConnectionFacade

protected DisposableConnectionFacade(JdbcInterceptor interceptor)

Construct a DisposableConnectionFacade that wraps the given interceptor.

Parameters:

interceptor - The next interceptor in the chain

Method Details

reset

public void reset(ConnectionPool parent,
 PooledConnection con)

Description copied from class: JdbcInterceptor

Gets called each time the connection is borrowed from the pool This means that if an interceptor holds a reference to the connection the interceptor can be reused for another connection.
This method may be called with null as both arguments when we are closing down the connection. When called for a shutdown reset, an interceptor that throws is isolated: the exception is logged and ignored, and the remaining interceptors in the chain are reset as well.

Specified by:

reset in class JdbcInterceptor

Parameters:

parent - - the connection pool owning the connection

con - - the pooled connection

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

invoke

public Object invoke(Object proxy,
 Method method,
 Object[] args)
              throws Throwable

Description copied from class: JdbcInterceptor

Gets invoked each time an operation on Connection is invoked.

Specified by:

invoke in interface InvocationHandler

Overrides:

invoke in class JdbcInterceptor

Throws:

Throwable