Top Description Fields Constructors Methods
org.hibernate.jdbc

public Class BorrowedConnectionProxy

extends Object
implements InvocationHandler
Class Inheritance
All Implemented Interfaces
java.lang.reflect.InvocationHandler
Imports
org.hibernate.HibernateException, java.lang.reflect.InvocationHandler, .Method, .Proxy, .InvocationTargetException, java.sql.Connection

A proxy for borrowed connections which funnels all requests back into the ConnectionManager from which it was borrowed to be properly handled (in terms of connection release modes).

Note

the term borrowed here refers to connection references obtained via org.hibernate.Session#connection() for application usage.

Author
Steve Ebersole

Field Summary

Modifier and TypeField and Description
private final ConnectionManager
private static final Class<T>[]
private boolean

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public static Connection

Returns:

The generated proxy.
generateProxy
(ConnectionManager
The connection manager to wrap with the connection proxy.
connectionManager
)

Generates a Connection proxy wrapping the connection managed by the passed connection manager.

public static ClassLoader

Returns:

The class loader appropriate for proxy construction.
getProxyClassLoader
()

Determines the appropriate class loader to which the generated proxy should be scoped.

public static Connection

Returns:

The unwrapped connection.
getWrappedConnection
(Connection
The connection (proxy) to be unwrapped.
connection
)

Convience method for unwrapping a connection proxy and getting a handle to an underlying connection.

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
)

Implements java.lang.reflect.InvocationHandler.invoke.

Processes a method invocation on a proxy instance and returns the result.
public static void
renderUnuseable(Connection
The connection (proxy) to be marked.
connection
)

Marks a borrowed connection as no longer usable.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

connectionManagerback to summary
private final ConnectionManager connectionManager
PROXY_INTERFACESback to summary
private static final Class<T>[] PROXY_INTERFACES
useableback to summary
private boolean useable

Constructor Detail

BorrowedConnectionProxyback to summary
public BorrowedConnectionProxy(ConnectionManager connectionManager)

Method Detail

generateProxyback to summary
public static Connection generateProxy(ConnectionManager connectionManager)

Generates a Connection proxy wrapping the connection managed by the passed connection manager.

Parameters
connectionManager:ConnectionManager

The connection manager to wrap with the connection proxy.

Returns:Connection

The generated proxy.

getProxyClassLoaderback to summary
public static ClassLoader getProxyClassLoader()

Determines the appropriate class loader to which the generated proxy should be scoped.

Returns:ClassLoader

The class loader appropriate for proxy construction.

getWrappedConnectionback to summary
public static Connection getWrappedConnection(Connection connection)

Convience method for unwrapping a connection proxy and getting a handle to an underlying connection.

Parameters
connection:Connection

The connection (proxy) to be unwrapped.

Returns:Connection

The unwrapped connection.

invokeback to summary
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable

Implements java.lang.reflect.InvocationHandler.invoke.

Doc from java.lang.reflect.InvocationHandler.invoke.

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

the proxy instance that the method was invoked on

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

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

Returns:Object

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.

Exceptions
Throwable:
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.
renderUnuseableback to summary
public static void renderUnuseable(Connection connection)

Marks a borrowed connection as no longer usable.

Parameters
connection:Connection

The connection (proxy) to be marked.