Top Description Fields Constructors Methods
org.apache.tomcat.jdbc.pool

public Class ProxyConnection

extends JdbcInterceptor
Class Inheritance
Imports
java.lang.reflect.InvocationTargetException, .Method, java.sql.SQLException, javax.sql.XAConnection

A ProxyConnection object is the bottom most interceptor that wraps an object of type PooledConnection. The ProxyConnection intercepts three methods: 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

Modifier and TypeField and Description
protected PooledConnection
protected ConnectionPool
Inherited from org.apache.tomcat.jdbc.pool.JdbcInterceptor:
CLOSE_VALEQUALS_VALGETCONNECTION_VALHASHCODE_VALISCLOSED_VALISVALID_VALISWRAPPERFOR_VALpropertiesTOSTRING_VALUNWRAP_VAL

Constructor Summary

AccessConstructor and Description
protected
ProxyConnection(ConnectionPool parent, PooledConnection con, boolean useEquals)

Method Summary

Modifier and TypeMethod and Description
public PooledConnection
public PooledConnection
public ConnectionPool
public ConnectionPool
public Object
invoke(Object
the proxy instance that the method was invoked on
proxy
,
Method
the Method instance corresponding to the interface method invoked on the proxy instance. The declaring class of the Method object will be the interface that the method was declared in, which may be a superinterface of the proxy interface that the proxy class inherits the method through.
method
,
Object[]
an array of objects containing the values of the arguments passed in the method invocation on the proxy instance, or null if interface method takes no arguments. Arguments of primitive types are wrapped in instances of the appropriate primitive wrapper class, such as java.lang.Integer or java.lang.Boolean.
args
)

Overrides org.apache.tomcat.jdbc.pool.JdbcInterceptor.invoke.

Implements java.lang.reflect.InvocationHandler.invoke.

Gets invoked each time an operation on java.sql.Connection is invoked.

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

public void
reset(ConnectionPool
- the connection pool owning the connection
parent
,
PooledConnection
- the pooled connection
con
)

Implements abstract org.apache.tomcat.jdbc.pool.JdbcInterceptor.reset.

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.

public void
public void
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

public Object
unwrap(Class<?> iface)

Inherited from org.apache.tomcat.jdbc.pool.JdbcInterceptor:
comparecomparedisconnectedgetNextgetPropertiesisUseEqualspoolClosedpoolStartedsetNextsetPropertiessetUseEquals

Field Detail

connectionback to summary
protected PooledConnection connection
poolback to summary
protected ConnectionPool pool

Constructor Detail

ProxyConnectionback to summary
protected ProxyConnection(ConnectionPool parent, PooledConnection con, boolean useEquals)

Method Detail

getConnectionback to summary
public PooledConnection getConnection()
getDelegateConnectionback to summary
public PooledConnection getDelegateConnection()
getParentPoolback to summary
public ConnectionPool getParentPool()
getPoolback to summary
public ConnectionPool getPool()
invokeback to summary
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable

Overrides org.apache.tomcat.jdbc.pool.JdbcInterceptor.invoke.

Implements java.lang.reflect.InvocationHandler.invoke.

Doc from org.apache.tomcat.jdbc.pool.JdbcInterceptor.invoke.

Gets invoked each time an operation on java.sql.Connection is invoked. Processes a method invocation on a proxy instance and returns the result. This method will be invoked on an invocation handler when a method is invoked on a proxy instance that it is associated with.

Parameters
proxy:Object

Doc from java.lang.reflect.InvocationHandler.invoke.

the proxy instance that the method was invoked on

method:Method

Doc from java.lang.reflect.InvocationHandler.invoke.

the Method instance corresponding to the interface method invoked on the proxy instance. The declaring class of the Method object will be the interface that the method was declared in, which may be a superinterface of the proxy interface that the proxy class inherits the method through.

args:Object[]

Doc from java.lang.reflect.InvocationHandler.invoke.

an array of objects containing the values of the arguments passed in the method invocation on the proxy instance, or null if interface method takes no arguments. Arguments of primitive types are wrapped in instances of the appropriate primitive wrapper class, such as java.lang.Integer or java.lang.Boolean.

Returns:Object

Doc from java.lang.reflect.InvocationHandler.invoke.

the value to return from the method invocation on the proxy instance. If the declared return type of the interface method is a primitive type, then the value returned by this method must be an instance of the corresponding primitive wrapper class; otherwise, it must be a type assignable to the declared return type. If the value returned by this method is null and the interface method's return type is primitive, then a NullPointerException will be thrown by the method invocation on the proxy instance. If the value returned by this method is otherwise not compatible with the interface method's declared return type as described above, a ClassCastException will be thrown by the method invocation on the proxy instance.

Annotations
@Override
Exceptions
Throwable:

Doc from java.lang.reflect.InvocationHandler.invoke.

the exception to throw from the method invocation on the proxy instance. The exception's type must be assignable either to any of the exception types declared in the throws clause of the interface method or to the unchecked exception types java.lang.RuntimeException or java.lang.Error. If a checked exception is thrown by this method that is not assignable to any of the exception types declared in the throws clause of the interface method, then an UndeclaredThrowableException containing the exception that was thrown by this method will be thrown by the method invocation on the proxy instance.

isClosedback to summary
public boolean isClosed()
isWrapperForback to summary
public boolean isWrapperFor(Class<?> iface)
resetback to summary
public void reset(ConnectionPool parent, PooledConnection con)

Implements abstract org.apache.tomcat.jdbc.pool.JdbcInterceptor.reset.

Doc from org.apache.tomcat.jdbc.pool.JdbcInterceptor.reset.

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.

Parameters
parent:ConnectionPool

- the connection pool owning the connection

con:PooledConnection

- the pooled connection

Annotations
@Override
setConnectionback to summary
public void setConnection(PooledConnection connection)
setPoolback to summary
public void setPool(ConnectionPool pool)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
unwrapback to summary
public Object unwrap(Class<?> iface) throws SQLException