Class StatementDecoratorInterceptor

java.lang.Object

org.apache.tomcat.jdbc.pool.JdbcInterceptor

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

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

All Implemented Interfaces:

InvocationHandler

Direct Known Subclasses:

StatementCache

public class StatementDecoratorInterceptor
extends AbstractCreateStatementInterceptor

Implementation of JdbcInterceptor that proxies resultSets and statements.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	StatementDecoratorInterceptor.ResultSetProxy	Invocation handler that proxies ResultSet instances.
protected class	StatementDecoratorInterceptor.StatementProxy<T extends Statement>	Class to measure query execute time.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	EXECUTE_QUERY	Method name for executeQuery.
protected static final String	GET_GENERATED_KEYS	Method name for getGeneratedKeys.
protected static final String	GET_RESULTSET	Method name for getResultSet.
protected static final String[]	RESULTSET_TYPES	Method names that return a ResultSet.
protected static Constructor<?>	resultSetConstructor	the constructor to create the resultSet proxies

Fields inherited from class AbstractCreateStatementInterceptor

constructors, CREATE_STATEMENT, CREATE_STATEMENT_IDX, EXECUTE, EXECUTE_BATCH, EXECUTE_LARGE_BATCH, EXECUTE_LARGE_UPDATE, EXECUTE_TYPES, EXECUTE_UPDATE, GET_STATEMENT, PREPARE_CALL, PREPARE_CALL_IDX, PREPARE_STATEMENT, PREPARE_STATEMENT_IDX, RESULTSET_IDX, STATEMENT_TYPE_COUNT, STATEMENT_TYPES

Modifier and Type	Field	Description
protected static final Constructor<?>[]	constructors	the constructors that are used to create statement proxies.
protected static final String	CREATE_STATEMENT	Connection.createStatement()
protected static final int	CREATE_STATEMENT_IDX	Index for AbstractCreateStatementInterceptor.CREATE_STATEMENT in AbstractCreateStatementInterceptor.STATEMENT_TYPES
protected static final String	EXECUTE	Statement.execute(String)
protected static final String	EXECUTE_BATCH	Statement.executeBatch()
protected static final String	EXECUTE_LARGE_BATCH	Statement.executeLargeBatch()
protected static final String	EXECUTE_LARGE_UPDATE	Statement.executeLargeUpdate(String) and its overloads, and PreparedStatement.executeLargeUpdate()
protected static final String[]	EXECUTE_TYPES	Array of execute type method names
protected static final String	EXECUTE_UPDATE	Statement.executeUpdate(String)
protected static final String	GET_STATEMENT	ResultSet.getStatement()
protected static final String	PREPARE_CALL	Connection.prepareCall(String)
protected static final int	PREPARE_CALL_IDX	Index for AbstractCreateStatementInterceptor.PREPARE_CALL in AbstractCreateStatementInterceptor.STATEMENT_TYPES
protected static final String	PREPARE_STATEMENT	Connection.prepareStatement(String)
protected static final int	PREPARE_STATEMENT_IDX	Index for AbstractCreateStatementInterceptor.PREPARE_STATEMENT in AbstractCreateStatementInterceptor.STATEMENT_TYPES
protected static final int	RESULTSET_IDX	Index for AbstractCreateStatementInterceptor.GET_STATEMENT in AbstractCreateStatementInterceptor.STATEMENT_TYPES
protected static final int	STATEMENT_TYPE_COUNT	Count of statement types in AbstractCreateStatementInterceptor.STATEMENT_TYPES
protected static final String[]	STATEMENT_TYPES	Array of statement type method names

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

Constructor	Description
StatementDecoratorInterceptor()	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	closeInvoked()	Method invoked when the operation Connection.close() is invoked.
protected Object	createDecorator(Object proxy, Method method, Object[] args, Object statement, Constructor<?> constructor, String sql)	Creates a proxy for a Statement.
Object	createStatement(Object proxy, Method method, Object[] args, Object statement, long time)	Creates a statement interceptor to monitor query response times
protected Constructor<?>	getResultSetConstructor()	Gets the constructor for creating ResultSet proxies.
protected boolean	isExecuteQuery(Method method)	Checks if the given method is executeQuery.
protected boolean	isExecuteQuery(String methodName)	Checks if the given method name is executeQuery.
protected boolean	isResultSet(Method method, boolean process)	Checks if the given method returns a ResultSet.

Methods inherited from class AbstractCreateStatementInterceptor

getConstructor, invoke, isExecute, isStatement, process, reset

Modifier and Type	Method	Description
protected Constructor<?>	getConstructor(int idx, Class<?> clazz)	Creates a constructor for a proxy class, if one doesn't already exist.
Object	invoke(Object proxy, Method method, Object[] args)	Gets invoked each time an operation on Connection is invoked.
protected boolean	isExecute(Method method, boolean process)	Returns true if the method that is being invoked matches one of the execute types.
protected boolean	isStatement(Method method, boolean process)	Returns true if the method that is being invoked matches one of the statement types.
protected boolean	process(String[] names, Method method, boolean process)	Returns true if the method that is being invoked matches one of the method names passed in
void	reset(ConnectionPool parent, PooledConnection con)	no-op for this interceptor. no state is stored.

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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

EXECUTE_QUERY

protected static final String EXECUTE_QUERY

Method name for executeQuery.

See Also:

• Constant Field Values

GET_GENERATED_KEYS

protected static final String GET_GENERATED_KEYS

Method name for getGeneratedKeys.

See Also:

• Constant Field Values

GET_RESULTSET

protected static final String GET_RESULTSET

Method name for getResultSet.

See Also:

• Constant Field Values

RESULTSET_TYPES

protected static final String[] RESULTSET_TYPES

Method names that return a ResultSet.

resultSetConstructor

protected static volatile Constructor<?> resultSetConstructor

the constructor to create the resultSet proxies

Constructor Details

StatementDecoratorInterceptor

public StatementDecoratorInterceptor()

Default constructor.

Method Details

closeInvoked

public void closeInvoked()

Description copied from class: AbstractCreateStatementInterceptor

Method invoked when the operation Connection.close() is invoked.

Specified by:

closeInvoked in class AbstractCreateStatementInterceptor

getResultSetConstructor

protected Constructor<?> getResultSetConstructor()
                                          throws NoSuchMethodException

Gets the constructor for creating ResultSet proxies.

Returns:

the ResultSet proxy constructor

Throws:

NoSuchMethodException - if the constructor is not found

createStatement

public Object createStatement(Object proxy,
 Method method,
 Object[] args,
 Object statement,
 long time)

Creates a statement interceptor to monitor query response times

Specified by:

createStatement in class AbstractCreateStatementInterceptor

Parameters:

proxy - the actual proxy object

method - the method that was called. It will be one of the methods defined in AbstractCreateStatementInterceptor.STATEMENT_TYPES

args - the arguments to the method

statement - the statement that the underlying connection created

time - Elapsed time

Returns:

a Statement object

createDecorator

protected Object createDecorator(Object proxy,
 Method method,
 Object[] args,
 Object statement,
 Constructor<?> constructor,
 String sql)
                          throws InstantiationException,
IllegalAccessException,
InvocationTargetException

Creates a proxy for a Statement.

Parameters:

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

method - The method that was called on the proxy

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

statement - The statement object that is to be proxied

constructor - The constructor for the desired proxy

sql - The sql of of the statement

Returns:

A new proxy for the Statement

Throws:

InstantiationException - Couldn't instantiate object

IllegalAccessException - Inaccessible constructor

InvocationTargetException - Exception thrown from constructor

isExecuteQuery

protected boolean isExecuteQuery(String methodName)

Checks if the given method name is executeQuery.

Parameters:

methodName - the method name to check

Returns:

true if the method is executeQuery

isExecuteQuery

protected boolean isExecuteQuery(Method method)

Checks if the given method is executeQuery.

Parameters:

method - the method to check

Returns:

true if the method is executeQuery

isResultSet

protected boolean isResultSet(Method method,
 boolean process)

Checks if the given method returns a ResultSet.

Parameters:

method - the method to check

process - whether processing is already enabled

Returns:

true if the method returns a ResultSet