Class ResetAbandonedTimer

java.lang.Object

org.apache.tomcat.jdbc.pool.JdbcInterceptor

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

org.apache.tomcat.jdbc.pool.interceptor.AbstractQueryReport

org.apache.tomcat.jdbc.pool.interceptor.ResetAbandonedTimer

All Implemented Interfaces:

InvocationHandler, ResetAbandonedTimerMBean

public class ResetAbandonedTimer
extends AbstractQueryReport
implements ResetAbandonedTimerMBean

Class that resets the abandoned timer on any activity on the Connection, on any query execution and on any read of a ResultSet returned by a statement obtained from the pooled connection, whether the operation completed successfully or failed. Iterating a large result set therefore keeps the connection alive through the fetch phase, not only until the query returns. Each reset happens when an individual call completes, so a single call that itself blocks on the database for longer than PoolConfiguration.setRemoveAbandonedTimeout(int) still gets the connection abandoned. The statement facade is always used, so a result set handle that outlives its borrow is sealed off before it can go on refreshing the abandoned timer of whoever holds that physical connection next. The handles this interceptor hands out release what they wrap - the statement layer, the physical result set - once a close has been forwarded to it, and answer any later call from the closed contract, as the statement facade's own handles do; a handle the application keeps beyond its close therefore stops keeping the physical objects below it reachable. This interceptor is useful for when you have a PoolConfiguration.setRemoveAbandonedTimeout(int) that is fairly low, and you want to reset the abandoned time each time any operation on the connection is performed This is useful for batch processing programs that use connections for extensive amount of times.

Nested Class Summary

Nested classes/interfaces inherited from class AbstractQueryReport

AbstractQueryReport.StatementProxy

Modifier and Type	Class	Description
protected class	AbstractQueryReport.StatementProxy	Class to measure query execute time

Field Summary

Fields inherited from class AbstractQueryReport

threshold

Modifier and Type	Field	Description
protected long	threshold	The threshold in milliseconds.

Fields inherited from class AbstractCreateStatementInterceptor

constructors, CREATE_STATEMENT, CREATE_STATEMENT_IDX, EXECUTE, EXECUTE_BATCH, EXECUTE_LARGE_BATCH, EXECUTE_LARGE_UPDATE, EXECUTE_QUERY, EXECUTE_TYPES, EXECUTE_UPDATE, GET_GENERATED_KEYS, GET_RESULTSET, 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_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 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
ResetAbandonedTimer()	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	closeInvoked()	Method invoked when the operation Connection.close() is invoked.
Object	createStatement(Object proxy, Method method, Object[] args, Object statement, long time)	Wraps the query reporting statement proxy so that the result sets handed to the application reset the abandoned timer while they are read.
Object	invoke(Object proxy, Method method, Object[] args)	Gets invoked each time an operation on Connection is invoked.
protected void	prepareCall(String query, long time)	Invoked when prepareCall has been called and completed.
protected void	prepareStatement(String sql, long time)	Invoked when prepareStatement has been called and completed.
protected String	reportFailedQuery(String query, Object[] args, String name, long start, long delta, Throwable t)	Invoked when a query execution, a call to an execute method as recognised by AbstractCreateStatementInterceptor.isExecute(Method, boolean), failed.
protected String	reportQuery(String query, Object[] args, String name, long start, long delta)	Invoked when a query execution, a call to an execute method as recognised by AbstractCreateStatementInterceptor.isExecute(Method, boolean), succeeded and was within the timing threshold
protected String	reportSlowQuery(String query, Object[] args, String name, long start, long delta)	Invoked when a query execution, a call to an execute method as recognised by AbstractCreateStatementInterceptor.isExecute(Method, boolean), succeeded and was exceeded the timing threshold
void	reset(ConnectionPool parent, PooledConnection con)	no-op for this interceptor. no state is stored.
boolean	resetTimer()	Reset the abandoned timer for the pooled connection.

Methods inherited from class AbstractQueryReport

getThreshold, setThreshold

Modifier and Type	Method	Description
long	getThreshold()	returns the query measure threshold.
void	setThreshold(long threshold)	Sets the query measurement threshold.

Methods inherited from class AbstractCreateStatementInterceptor

getConstructor, isExecute, isStatement, process

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

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

Constructor Details

ResetAbandonedTimer

public ResetAbandonedTimer()

Default constructor.

Method Details

reset

public void reset(ConnectionPool parent,
 PooledConnection con)

Description copied from class: AbstractCreateStatementInterceptor

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

Overrides:

reset in class AbstractCreateStatementInterceptor

Parameters:

parent - - the connection pool owning the connection

con - - the pooled connection

resetTimer

public boolean resetTimer()

Description copied from interface: ResetAbandonedTimerMBean

Reset the abandoned timer for the pooled connection.

Specified by:

resetTimer in interface ResetAbandonedTimerMBean

Returns:

True if the timer was reset, false if no connection is associated

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 AbstractCreateStatementInterceptor

Throws:

Throwable

createStatement

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

Wraps the query reporting statement proxy so that the result sets handed to the application reset the abandoned timer while they are read. Statements that this interceptor does not proxy are passed through unchanged.

Overrides:

createStatement in class AbstractQueryReport

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

prepareCall

protected void prepareCall(String query,
 long time)

Description copied from class: AbstractQueryReport

Invoked when prepareCall has been called and completed.

Specified by:

prepareCall in class AbstractQueryReport

Parameters:

query - - the string used to prepare the statement with

time - - the time it took to invoke prepare

prepareStatement

protected void prepareStatement(String sql,
 long time)

Description copied from class: AbstractQueryReport

Invoked when prepareStatement has been called and completed.

Specified by:

prepareStatement in class AbstractQueryReport

Parameters:

sql - - the string used to prepare the statement with

time - - the time it took to invoke prepare

closeInvoked

public void closeInvoked()

Description copied from class: AbstractCreateStatementInterceptor

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

Specified by:

closeInvoked in class AbstractCreateStatementInterceptor

reportFailedQuery

protected String reportFailedQuery(String query,
 Object[] args,
 String name,
 long start,
 long delta,
 Throwable t)

Description copied from class: AbstractQueryReport

Invoked when a query execution, a call to an execute method as recognised by AbstractCreateStatementInterceptor.isExecute(Method, boolean), failed.

Overrides:

reportFailedQuery in class AbstractQueryReport

Parameters:

query - the query that was executed and failed

args - the arguments to the execution

name - the name of the method used to execute AbstractCreateStatementInterceptor.isExecute(Method, boolean)

start - the wall clock time the query execution started

delta - the time the execution took before it failed, measured with the monotonic clock

t - the exception that happened

Returns:

- the SQL that was executed or the string "batch" if it was a batch execution, or null if the invocation carries no SQL string

reportQuery

protected String reportQuery(String query,
 Object[] args,
 String name,
 long start,
 long delta)

Description copied from class: AbstractQueryReport

Invoked when a query execution, a call to an execute method as recognised by AbstractCreateStatementInterceptor.isExecute(Method, boolean), succeeded and was within the timing threshold

Overrides:

reportQuery in class AbstractQueryReport

Parameters:

query - the query that was executed and failed

args - the arguments to the execution

name - the name of the method used to execute AbstractCreateStatementInterceptor.isExecute(Method, boolean)

start - the wall clock time the query execution started

delta - the time the execution took, measured with the monotonic clock

Returns:

- the SQL that was executed or the string "batch" if it was a batch execution, or null if the invocation carries no SQL string

reportSlowQuery

protected String reportSlowQuery(String query,
 Object[] args,
 String name,
 long start,
 long delta)

Description copied from class: AbstractQueryReport

Invoked when a query execution, a call to an execute method as recognised by AbstractCreateStatementInterceptor.isExecute(Method, boolean), succeeded and was exceeded the timing threshold

Overrides:

reportSlowQuery in class AbstractQueryReport

Parameters:

query - the query that was executed and failed

args - the arguments to the execution

name - the name of the method used to execute AbstractCreateStatementInterceptor.isExecute(Method, boolean)

start - the wall clock time the query execution started

delta - the time the execution took, measured with the monotonic clock

Returns:

- the SQL that was executed or the string "batch" if it was a batch execution, or null if the invocation carries no SQL string