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

public Class StatementCache

extends StatementDecoratorInterceptor
implements StatementCacheMBean
Class Inheritance
All Implemented Interfaces
org.apache.tomcat.jdbc.pool.interceptor.StatementCacheMBean
Imports
java.lang.reflect.Constructor, .InvocationTargetException, .Method, java.sql.PreparedStatement, .ResultSet, .SQLException, java.util.Arrays, .Map, java.util.concurrent.ConcurrentHashMap, java.util.concurrent.atomic.AtomicInteger, javax.management.ObjectName, org.apache.juli.logging.Log, .LogFactory, org.apache.tomcat.jdbc.pool.ConnectionPool, .PoolProperties.InterceptorProperty, .PooledConnection, org.apache.tomcat.jdbc.pool.jmx.JmxUtil

Interceptor that caches PreparedStatement and/or CallableStatement instances on a connection.

Nested and Inner Type Summary

Modifier and TypeClass and Description
protected class
private static class

Field Summary

Modifier and TypeField and Description
protected static final String[]
private boolean
private boolean
private AtomicInteger
private static ConcurrentHashMap<ConnectionPool, AtomicInteger>
protected static final String[]
private static final Log
private int
protected static final String[]
private ObjectName
private PooledConnection
protected static final String[]
protected static final String
private String[]
Inherited from org.apache.tomcat.jdbc.pool.interceptor.StatementDecoratorInterceptor:
EXECUTE_QUERYGET_GENERATED_KEYSGET_RESULTSETRESULTSET_TYPESresultSetConstructor

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public boolean
public void
protected StatementCache.CacheKey
createCacheKey(Method method, Object[] args)

protected StatementCache.CacheKey
createCacheKey(String methodName, Object[] args)

protected Object
createDecorator(Object
The proxy object on which the method that triggered the creation of the statement was called.
proxy
,
Method
The method that was called on the proxy
method
,
Object[]
The arguments passed as part of the method call to the proxy
args
,
Object
The statement object that is to be proxied
statement
,
Constructor<?>
The constructor for the desired proxy
constructor
,
String
The sql of of the statement
sql
)

Overrides org.apache.tomcat.jdbc.pool.interceptor.StatementDecoratorInterceptor.createDecorator.

Creates a proxy for a Statement.

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.

protected ConcurrentHashMap<StatementCache.CacheKey, StatementCache.CachedStatement>
public AtomicInteger
public int
public int
public String[]
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.interceptor.AbstractCreateStatementInterceptor.invoke.

Implements java.lang.reflect.InvocationHandler.invoke.

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

public boolean
public StatementCache.CachedStatement
isCached(Method method, Object[] args)

public boolean
public void
poolClosed(ConnectionPool
- the pool that is being closed.
pool
)

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

This method is invoked by a connection pool when the pool is closed.

public void
poolStarted(ConnectionPool
- the pool that is being closed.
pool
)

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

This method is invoked by a connection pool when the pool is first started up, usually when the first connection is requested.

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

Overrides org.apache.tomcat.jdbc.pool.interceptor.AbstractCreateStatementInterceptor.reset.

no-op for this interceptor.

public void
setProperties(Map<String, PoolProperties.InterceptorProperty>
The properties
properties
)

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

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

Inherited from org.apache.tomcat.jdbc.pool.interceptor.StatementDecoratorInterceptor:
closeInvokedcreateStatementgetResultSetConstructorisExecuteQueryisExecuteQueryisResultSet

Field Detail

ALL_TYPESback to summary
protected static final String[] ALL_TYPES
cacheCallableback to summary
private boolean cacheCallable
cachePreparedback to summary
private boolean cachePrepared
cacheSizeback to summary
private AtomicInteger cacheSize
cacheSizeMapback to summary
private static ConcurrentHashMap<ConnectionPool, AtomicInteger> cacheSizeMap
CALLABLE_TYPEback to summary
protected static final String[] CALLABLE_TYPE
logback to summary
private static final Log log
maxCacheSizeback to summary
private int maxCacheSize
NO_TYPEback to summary
protected static final String[] NO_TYPE
onameback to summary
private ObjectName oname
pconback to summary
private PooledConnection pcon
PREPARED_TYPEback to summary
protected static final String[] PREPARED_TYPE
STATEMENT_CACHE_ATTRback to summary
protected static final String STATEMENT_CACHE_ATTR
typesback to summary
private String[] types

Constructor Detail

StatementCacheback to summary
public StatementCache()

Method Detail

cacheStatementback to summary
public boolean cacheStatement(StatementCache.CachedStatement proxy)
closeStatementback to summary
public void closeStatement(StatementCache.CachedStatement st)
createCacheKeyback to summary
protected StatementCache.CacheKey createCacheKey(Method method, Object[] args)
createCacheKeyback to summary
protected StatementCache.CacheKey createCacheKey(String methodName, Object[] args)
createDecoratorback to summary
protected Object createDecorator(Object proxy, Method method, Object[] args, Object statement, Constructor<?> constructor, String sql) throws InstantiationException, IllegalAccessException, InvocationTargetException

Overrides org.apache.tomcat.jdbc.pool.interceptor.StatementDecoratorInterceptor.createDecorator.

Doc from org.apache.tomcat.jdbc.pool.interceptor.StatementDecoratorInterceptor.createDecorator.

Creates a proxy for a Statement.

Parameters
proxy:Object

The proxy object on which the method that triggered the creation of the statement was called.

method:Method

The method that was called on the proxy

args:Object[]

The arguments passed as part of the method call to the proxy

statement:Object

The statement object that is to be proxied

constructor:Constructor<?>

The constructor for the desired proxy

sql:String

The sql of of the statement

Returns:Object

A new proxy for the Statement

Annotations
@Override
Exceptions
InstantiationException:
Couldn't instantiate object
IllegalAccessException:
Inaccessible constructor
InvocationTargetException:
Exception thrown from constructor
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
getCacheback to summary
protected ConcurrentHashMap<StatementCache.CacheKey, StatementCache.CachedStatement> getCache()
getCacheSizeback to summary
public AtomicInteger getCacheSize()

Implements org.apache.tomcat.jdbc.pool.interceptor.StatementCacheMBean.getCacheSize.

Annotations
@Override
getCacheSizePerConnectionback to summary
public int getCacheSizePerConnection()

Implements org.apache.tomcat.jdbc.pool.interceptor.StatementCacheMBean.getCacheSizePerConnection.

Annotations
@Override
getMaxCacheSizeback to summary
public int getMaxCacheSize()

Implements org.apache.tomcat.jdbc.pool.interceptor.StatementCacheMBean.getMaxCacheSize.

Annotations
@Override
getTypesback to summary
public String[] getTypes()
invokeback to summary
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable

Overrides org.apache.tomcat.jdbc.pool.interceptor.AbstractCreateStatementInterceptor.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.

isCacheCallableback to summary
public boolean isCacheCallable()

Implements org.apache.tomcat.jdbc.pool.interceptor.StatementCacheMBean.isCacheCallable.

Annotations
@Override
isCachedback to summary
public StatementCache.CachedStatement isCached(Method method, Object[] args)
isCachePreparedback to summary
public boolean isCachePrepared()

Implements org.apache.tomcat.jdbc.pool.interceptor.StatementCacheMBean.isCachePrepared.

Annotations
@Override
poolClosedback to summary
public void poolClosed(ConnectionPool pool)

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

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

This method is invoked by a connection pool when the pool is closed. Interceptor classes can override this method if they keep static variables or other tracking means around. This method is only invoked on a single instance of the interceptor, and not on every instance created.

Parameters
pool:ConnectionPool

- the pool that is being closed.

Annotations
@Override
poolStartedback to summary
public void poolStarted(ConnectionPool pool)

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

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

This method is invoked by a connection pool when the pool is first started up, usually when the first connection is requested. Interceptor classes can override this method if they keep static variables or other tracking means around. This method is only invoked on a single instance of the interceptor, and not on every instance created.

Parameters
pool:ConnectionPool

- the pool that is being closed.

Annotations
@Override
removeStatementback to summary
public boolean removeStatement(StatementCache.CachedStatement proxy)
resetback to summary
public void reset(ConnectionPool parent, PooledConnection con)

Overrides org.apache.tomcat.jdbc.pool.interceptor.AbstractCreateStatementInterceptor.reset.

Doc from org.apache.tomcat.jdbc.pool.interceptor.AbstractCreateStatementInterceptor.reset.

no-op for this interceptor. no state is stored.

Parameters
parent:ConnectionPool

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

- the connection pool owning the connection

con:PooledConnection

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

- the pooled connection

Annotations
@Override
setPropertiesback to summary
public void setProperties(Map<String, PoolProperties.InterceptorProperty> properties)

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

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

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

Parameters
properties:Map<String, PoolProperties.InterceptorProperty>

The properties

Annotations
@Override
org.apache.tomcat.jdbc.pool.interceptor back to summary

protected Class StatementCache.CachedStatement

extends StatementDecoratorInterceptor.StatementProxy<PreparedStatement>
Class Inheritance

Field Summary

Modifier and TypeField and Description
pack-priv StatementCache.CacheKey
Inherited from org.apache.tomcat.jdbc.pool.interceptor.StatementDecoratorInterceptor.StatementProxy:
closeddelegate

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public void
public void
public StatementCache.CacheKey
public void
Inherited from org.apache.tomcat.jdbc.pool.interceptor.StatementDecoratorInterceptor.StatementProxy:
getActualProxygetConnectiongetConstructorgetDelegategetSqlinvokesetActualProxysetConnectionsetConstructortoString

Field Detail

keyback to summary
pack-priv StatementCache.CacheKey key

Constructor Detail

CachedStatementback to summary
public CachedStatement(PreparedStatement parent, String sql)

Method Detail

closeInvokedback to summary
public void closeInvoked()

Overrides org.apache.tomcat.jdbc.pool.interceptor.StatementDecoratorInterceptor.StatementProxy.closeInvoked.

Annotations
@Override
forceCloseback to summary
public void forceClose()
getCacheKeyback to summary
public StatementCache.CacheKey getCacheKey()
setCacheKeyback to summary
public void setCacheKey(StatementCache.CacheKey cacheKey)
org.apache.tomcat.jdbc.pool.interceptor back to summary

private final Class StatementCache.CacheKey

extends Object
Class Inheritance
  • java.lang.Object
  • org.apache.tomcat.jdbc.pool.interceptor.StatementCache.CacheKey

Field Summary

Modifier and TypeField and Description
private final Object[]
private final String

Constructor Summary

AccessConstructor and Description
private
CacheKey(String type, Object[] methodArgs)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
obj
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

argsback to summary
private final Object[] args
stmtTypeback to summary
private final String stmtType

Constructor Detail

CacheKeyback to summary
private CacheKey(String type, Object[] methodArgs)

Method Detail

equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override