Class AbstractCreateStatementInterceptor

java.lang.Object

org.apache.tomcat.jdbc.pool.JdbcInterceptor

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

All Implemented Interfaces:

InvocationHandler

Direct Known Subclasses:

AbstractQueryReport, QueryTimeoutInterceptor, StatementDecoratorInterceptor, StatementFacade, StatementFinalizer

public abstract class AbstractCreateStatementInterceptor
extends JdbcInterceptor

Abstraction interceptor. This component intercepts all calls to create some type of SQL statement. By extending this class, one can intercept queries and update statements by overriding the createStatement(Object, Method, Object[], Object, long) method.

Field Summary

Fields

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 CREATE_STATEMENT in 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_QUERY	Statement.executeQuery(String)
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_GENERATED_KEYS	Statement.getGeneratedKeys()
protected static final String	GET_RESULTSET	Statement.getResultSet()
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 PREPARE_CALL in STATEMENT_TYPES
protected static final String	PREPARE_STATEMENT	Connection.prepareStatement(String)
protected static final int	PREPARE_STATEMENT_IDX	Index for PREPARE_STATEMENT in STATEMENT_TYPES
protected static final int	RESULTSET_IDX	Index for GET_STATEMENT in STATEMENT_TYPES
protected static final int	STATEMENT_TYPE_COUNT	Count of statement types in 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
AbstractCreateStatementInterceptor()	Default constructor

Method Summary

Modifier and Type	Method	Description
abstract void	closeInvoked()	Method invoked when the operation Connection.close() is invoked.
abstract Object	createStatement(Object proxy, Method method, Object[] args, Object statement, long time)	This method will be invoked after a successful statement creation.
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

CREATE_STATEMENT

protected static final String CREATE_STATEMENT

Connection.createStatement()

See Also:

• Constant Field Values

CREATE_STATEMENT_IDX

protected static final int CREATE_STATEMENT_IDX

Index for CREATE_STATEMENT in STATEMENT_TYPES

See Also:

• Constant Field Values

PREPARE_STATEMENT

protected static final String PREPARE_STATEMENT

Connection.prepareStatement(String)

See Also:

• Constant Field Values

PREPARE_STATEMENT_IDX

protected static final int PREPARE_STATEMENT_IDX

Index for PREPARE_STATEMENT in STATEMENT_TYPES

See Also:

• Constant Field Values

PREPARE_CALL

protected static final String PREPARE_CALL

Connection.prepareCall(String)

See Also:

• Constant Field Values

PREPARE_CALL_IDX

protected static final int PREPARE_CALL_IDX

Index for PREPARE_CALL in STATEMENT_TYPES

See Also:

• Constant Field Values

GET_RESULTSET

protected static final String GET_RESULTSET

Statement.getResultSet()

See Also:

• Constant Field Values

GET_GENERATED_KEYS

protected static final String GET_GENERATED_KEYS

Statement.getGeneratedKeys()

See Also:

• Constant Field Values

GET_STATEMENT

protected static final String GET_STATEMENT

ResultSet.getStatement()

See Also:

• Constant Field Values

RESULTSET_IDX

protected static final int RESULTSET_IDX

Index for GET_STATEMENT in STATEMENT_TYPES

See Also:

• Constant Field Values

STATEMENT_TYPES

protected static final String[] STATEMENT_TYPES

Array of statement type method names

STATEMENT_TYPE_COUNT

protected static final int STATEMENT_TYPE_COUNT

Count of statement types in STATEMENT_TYPES

EXECUTE

protected static final String EXECUTE

Statement.execute(String)

See Also:

• Constant Field Values

EXECUTE_QUERY

protected static final String EXECUTE_QUERY

Statement.executeQuery(String)

See Also:

• Constant Field Values

EXECUTE_UPDATE

protected static final String EXECUTE_UPDATE

Statement.executeUpdate(String)

See Also:

• Constant Field Values

EXECUTE_BATCH

protected static final String EXECUTE_BATCH

Statement.executeBatch()

See Also:

• Constant Field Values

EXECUTE_LARGE_UPDATE

protected static final String EXECUTE_LARGE_UPDATE

Statement.executeLargeUpdate(String) and its overloads, and PreparedStatement.executeLargeUpdate()

See Also:

• Constant Field Values

EXECUTE_LARGE_BATCH

protected static final String EXECUTE_LARGE_BATCH

Statement.executeLargeBatch()

See Also:

• Constant Field Values

EXECUTE_TYPES

protected static final String[] EXECUTE_TYPES

Array of execute type method names

constructors

protected static final Constructor<?>[] constructors

the constructors that are used to create statement proxies. The cache is shared by all subclasses loaded through the same class loader, so every use of an index must pass an interface that the cached proxy implements, in practice always the same one; getConstructor(int, Class) enforces this. The canonical entries are populated by this class's initializer, which the JVM runs once and whose writes it publishes to every thread that uses the class, so reading a slot through getConstructor(int, Class) needs no locking; writing an element directly from a subclass bypasses that guarantee and is the subclass's own responsibility.

Constructor Details

AbstractCreateStatementInterceptor

public AbstractCreateStatementInterceptor()

Default constructor

Method Details

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

getConstructor

protected Constructor<?> getConstructor(int idx,
 Class<?> clazz)
                                 throws NoSuchMethodException

Creates a constructor for a proxy class, if one doesn't already exist. The canonical entries are published by this class's initializer, so on the normal path the method only reads a safely published slot and is safe for concurrent use; newInstance on the returned constructor runs as it always has, outside this method.

Parameters:

idx - - the index of the constructor

clazz - - the interface that the proxy will implement

Returns:

- returns a constructor used to create new instances

Throws:

NoSuchMethodException - Constructor not found

IllegalStateException - The index is already cached for a proxy class that does not implement clazz. Every use of an index in this shared cache must pass an interface that the cached proxy implements.

createStatement

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

This method will be invoked after a successful statement creation. This method can choose to return a wrapper around the statement or return the statement itself. If this method returns a wrapper then it should return a wrapper object that implements one of the following interfaces. Statement, PreparedStatement or CallableStatement

Parameters:

proxy - the actual proxy object

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

args - the arguments to the method

statement - the statement that the underlying connection created

time - Elapsed time

Returns:

a Statement object

closeInvoked

public abstract void closeInvoked()

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

isStatement

protected boolean isStatement(Method method,
 boolean process)

Returns true if the method that is being invoked matches one of the statement types.

Parameters:

method - the method being invoked on the proxy

process - boolean result used for recursion

Returns:

returns true if the method name matched

isExecute

protected boolean isExecute(Method method,
 boolean process)

Returns true if the method that is being invoked matches one of the execute types.

Parameters:

method - the method being invoked on the proxy

process - boolean result used for recursion

Returns:

returns true if the method name matched

process

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

Parameters:

names - list of method names that we want to intercept

method - the method being invoked on the proxy

process - boolean result used for recursion

Returns:

returns true if the method name matched

reset

public void reset(ConnectionPool parent,
 PooledConnection con)

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

Specified by:

reset in class JdbcInterceptor

Parameters:

parent - - the connection pool owning the connection

con - - the pooled connection