Class TrapException

java.lang.Object

org.apache.tomcat.jdbc.pool.JdbcInterceptor

org.apache.tomcat.jdbc.pool.TrapException

All Implemented Interfaces:

InvocationHandler

public class TrapException
extends JdbcInterceptor

Interceptor that traps any unhandled exception types and throws an exception that has been declared by the method called, or throw an SQLException if it is declared. If the caught exception is not declared, and the method doesn't throw SQLException, then this interceptor will throw a RuntimeException

Field Summary

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
TrapException()	Constructs a new TrapException interceptor.

Method Summary

Modifier and Type	Method	Description
Object	invoke(Object proxy, Method method, Object[] args)	Gets invoked each time an operation on Connection is invoked.
boolean	isDeclaredException(Method m, Class<?> clazz)	Checks if the given exception class is declared in the throws clause of the specified method.
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

Constructor Details

TrapException

public TrapException()

Constructs a new TrapException interceptor.

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

isDeclaredException

public boolean isDeclaredException(Method m,
 Class<?> clazz)

Checks if the given exception class is declared in the throws clause of the specified method.

Parameters:

m - The method to check

clazz - The exception class to look for

Returns:

true if the exception is declared, false otherwise

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