ehcache-core 2.10.9.2 · net.sf.ehcache.exceptionhandler.ExceptionHandlingDynamicCacheProxy

A dynamic proxy which provides CacheException handling.

The ehcache configuration will create and register in the CacheManager Ehcaches decorated with this dynamic proxy. See following for programmatic use.

The createProxy factory method may be used to simply create a proxy. Otherwise the calling client will need code similar to:

(Ehcache) Proxy.newProxyInstance(ehcache.getClass().getClassLoader(), new Class[]{ Ehcache.class },
new ExceptionHandlingDynamicCacheProxy(ehcache));

A common usage is to create a proxy and then register the proxy in CacheManager in place of the underlying cache. To do that create a proxy and then call

cacheManager.replaceCacheWithDecoratedCache(Ehcache cache, Ehcache decoratedCache);

All clients accessing the cache throughcacheManager.getEhcache() will then receive proxy references.

See CacheTest for a perf test.

Modifier and Type	Field and Description
private Ehcache	ehcache
private static final Logger	LOG

Constructor Summary

Access	Constructor and Description
public	ExceptionHandlingDynamicCacheProxy(Ehcache the backing ehcache ehcache) Constructor: Use with something like: (Ehcache) Proxy.newProxyInstance(ehcache.getClass().getClassLoader(), new Class[]{ Ehcache.class }, new ExceptionHandlingDynamicCacheProxy(ehcache));

Method Summary

Modifier and Type	Method and Description
public static Ehcache	Returns: a proxied Ehcache createProxy(Ehcache the target cache ehcache) A simple factory method to hide the messiness of creating the proxy from clients.
pack-priv static String	extractKey(String message) Extracts the key from the message, if any
public Object	Returns: 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. 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.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ehcache	back to summary
private Ehcache ehcache

LOG	back to summary
private static final Logger LOG

Constructor Detail

ExceptionHandlingDynamicCacheProxy	back to summary
public ExceptionHandlingDynamicCacheProxy(Ehcache ehcache) Constructor: Use with something like: (Ehcache) Proxy.newProxyInstance(ehcache.getClass().getClassLoader(), new Class[]{ Ehcache.class }, new ExceptionHandlingDynamicCacheProxy(ehcache)); Parameters ehcache:Ehcache the backing ehcache

ExceptionHandlingDynamicCacheProxy

back to summary

public ExceptionHandlingDynamicCacheProxy(Ehcache ehcache)

Constructor: Use with something like:

(Ehcache) Proxy.newProxyInstance(ehcache.getClass().getClassLoader(), new Class[]{ Ehcache.class },
new ExceptionHandlingDynamicCacheProxy(ehcache));

Parameters

ehcache:Ehcache: the backing ehcache

Method Detail

createProxy	back to summary
public static Ehcache createProxy(Ehcache ehcache) A simple factory method to hide the messiness of creating the proxy from clients. Parameters ehcache:Ehcache the target cache Returns:Ehcache a proxied Ehcache

createProxy

back to summary

public static Ehcache createProxy(Ehcache ehcache)

A simple factory method to hide the messiness of creating the proxy from clients.

Parameters

ehcache:Ehcache: the target cache

Returns:Ehcache

a proxied Ehcache

extractKey	back to summary
pack-priv static String extractKey(String message) Extracts the key from the message, if any

invoke back to summary

invoke	back to summary
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable Implements 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 `java.lang.reflect.UndeclaredThrowableException` containing the exception that was thrown by this method will be thrown by the method invocation on the proxy instance. See Also `java.lang.reflect.UndeclaredThrowableException`

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

Implements 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 java.lang.reflect.UndeclaredThrowableException containing the exception that was thrown by this method will be thrown by the method invocation on the proxy instance.

public final Class ExceptionHandlingDynamicCacheProxy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail