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

public Class ConnectionState

extends JdbcInterceptor
Class Inheritance
Imports
java.lang.reflect.Method, java.sql.SQLException, org.apache.juli.logging.Log, .LogFactory, org.apache.tomcat.jdbc.pool.ConnectionPool, .DataSourceFactory, .JdbcInterceptor, .PoolConfiguration, .PooledConnection
Interceptor that keep track of connection state to avoid roundtrips to the database. The org.apache.tomcat.jdbc.pool.ConnectionPool is optimized to do as little work as possible. The pool itself doesn't remember settings like java.sql.Connection#setAutoCommit(boolean), java.sql.Connection#setReadOnly(boolean), java.sql.Connection#setCatalog(String) or java.sql.Connection#setTransactionIsolation(int). It relies on the application to remember how and when these settings have been applied. In the cases where the application code doesn't know or want to keep track of the state, this interceptor helps cache the state, and it also avoids roundtrips to the database asking for it.

Field Summary

Modifier and TypeField and Description
protected Boolean
autoCommit

protected String
catalog

private static final Log
log

protected Boolean
readOnly

protected final String[]
readState

protected Integer
transactionIsolation

protected final String[]
writeState

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

Constructor Summary

AccessConstructor and Description
public
ConnectionState()

Method Summary

Modifier and TypeMethod and Description
public void
disconnected(ConnectionPool
- the connection pool that this connection belongs to
parent, PooledConnection
- the pooled connection that holds this connection
con, boolean
- if this connection is finalizing. True means that the pooled connection will not reconnect the underlying connection
finalizing)

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

Called when java.sql.Connection#close() is called on the underlying connection.

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 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.

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

Field Detail

autoCommitback to summary
protected Boolean autoCommit
catalogback to summary
protected String catalog
logback to summary
private static final Log log
readOnlyback to summary
protected Boolean readOnly
readStateback to summary
protected final String[] readState
transactionIsolationback to summary
protected Integer transactionIsolation
writeStateback to summary
protected final String[] writeState

Constructor Detail

ConnectionStateback to summary
public ConnectionState()

Method Detail

disconnectedback to summary
public void disconnected(ConnectionPool parent, PooledConnection con, boolean finalizing)

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

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

Called when java.sql.Connection#close() is called on the underlying connection. This is to notify the interceptors, that the physical connection has been released. Implementation of this method should be thought through with care, as no actions should trigger an exception.

Parameters
parent:ConnectionPool

- the connection pool that this connection belongs to

con:PooledConnection

- the pooled connection that holds this connection

finalizing:boolean

- if this connection is finalizing. True means that the pooled connection will not reconnect the underlying connection

Annotations
@Override
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.

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