org.jsr107.ri.annotations

Class AbstractCacheLookupUtil<I>

java.lang.Object

org.jsr107.ri.annotations.AbstractCacheLookupUtil<I>

Type Parameters:

I - The intercepted method invocation

All Implemented Interfaces:

CacheContextSource<I>

public abstract class AbstractCacheLookupUtil<I>
extends Object
implements CacheContextSource<I>

Utility used by all annotations to lookup the CacheResolver and CacheKeyGenerator for a given method.

Since:

1.0

Author:

Rick Hightower, Eric Dalquist

Constructor Summary

Constructors

Constructor and Description
AbstractCacheLookupUtil() Create lookup utility

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract InternalCacheInvocationContext<? extends Annotation>	createCacheInvocationContextImpl(StaticCacheInvocationContext<? extends Annotation> staticCacheInvocationContext, I invocation) Create the cache invocation context for the provided static context and intercepted method invocation
protected abstract InternalCacheKeyInvocationContext<? extends Annotation>	createCacheKeyInvocationContextImpl(StaticCacheKeyInvocationContext<? extends Annotation> staticCacheKeyInvocationContext, I invocation) Create the cache key invocation context for the provided static context and intercepted method invocation
protected <A extends Annotation> CacheMethodDetails<A>	createCacheMethodDetails(A cacheAnnotation, CacheDefaults cacheDefaultsAnnotation, String methodCacheName, Method method, Class<? extends Object> targetClass) Create CacheMethodDetails to describe the annotated method
protected CachePutMethodDetails	createCachePutMethodDetails(CachePut cachePutAnnotation, CacheDefaults cacheDefaultsAnnotation, Method method, Class<? extends Object> targetClass) Create a StaticCacheInvocationContext implementation specific to the CachePut annotated method
protected CacheRemoveAllMethodDetails	createCacheRemoveAllMethodDetails(CacheRemoveAll cacheRemoveAllAnnotation, CacheDefaults cacheDefaultsAnnotation, Method method, Class<? extends Object> targetClass) Create a StaticCacheInvocationContext implementation specific to the CacheRemoveAll annotated method
protected CacheRemoveEntryMethodDetails	createCacheRemoveEntryMethodDetails(CacheRemove cacheRemoveAnnotation, CacheDefaults cacheDefaultsAnnotation, Method method, Class<? extends Object> targetClass) Create a StaticCacheInvocationContext implementation specific to the CacheRemove annotated method
protected CacheResultMethodDetails	createCacheResultMethodDetails(CacheResult cacheResultAnnotation, CacheDefaults cacheDefaultsAnnotation, Method method, Class<? extends Object> targetClass) Create a StaticCacheInvocationContext implementation specific to the CacheResult annotated method
protected <T extends Annotation> T	getAnnotation(Class<T> annotationClass, Method method, Class<? extends Object> targetClass) Get the concrete annotation object for the method that will be invoked on the target class.
InternalCacheInvocationContext<? extends Annotation>	getCacheInvocationContext(I invocation) Get the AbstractInternalCacheInvocationContext for the invocation
protected CacheKeyGenerator	getCacheKeyGenerator(Class<? extends CacheKeyGenerator> cacheKeyGeneratorType, CacheDefaults cacheDefaultsAnnotation) Get the cache key generator based on the requested type and the defaults
InternalCacheKeyInvocationContext<? extends Annotation>	getCacheKeyInvocationContext(I invocation) Get the InternalCacheKeyInvocationContext for the CDI invocation.
protected CacheResolverFactory	getCacheResolverFactory(Class<? extends CacheResolverFactory> cacheResolverFactoryType, CacheDefaults cacheDefaultsAnnotation) Get the cache resolver factory based on the requested type and the defaults.
protected abstract CacheKeyGenerator	getDefaultCacheKeyGenerator()
protected abstract CacheResolverFactory	getDefaultCacheResolverFactory()
protected abstract Method	getMethod(I invocation)
protected Set<Annotation>	getMethodAnnotations(Method method) Get an immutable set of all annotations on the method
StaticCacheInvocationContext<? extends Annotation>	getMethodDetails(Method method, Class<? extends Object> targetClass) Get detailed data about an annotated method for a specific targeted class
protected abstract <T> T	getObjectByType(Class<T> type) Used to load CacheKeyGenerator and CacheResolverFactory instances by type
protected org.jsr107.ri.annotations.AbstractCacheLookupUtil.ParameterDetails	getParameterDetails(Method method, boolean cacheValueAllowed) Parse the parameters for a Method and create immutable CacheParameterDetails lists
protected abstract Class<?>	getTargetClass(I invocation)
protected String	resolveCacheName(String methodCacheName, CacheDefaults cacheDefaultsAnnotation, Method method, Class<? extends Object> targetClass) Determine the cache name to use based on the method and class level annotations

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractCacheLookupUtil

public AbstractCacheLookupUtil()

Create lookup utility

Method Detail

getCacheKeyInvocationContext

public InternalCacheKeyInvocationContext<? extends Annotation> getCacheKeyInvocationContext(I invocation)

Get the InternalCacheKeyInvocationContext for the CDI invocation.

Specified by:

getCacheKeyInvocationContext in interface CacheContextSource<I>

Parameters:

invocation - The CDI invocation context

Returns:

The keyed cache invocation context

Throws:

UnsupportedOperationException - if the invocation context is available for the invocation

createCacheKeyInvocationContextImpl

protected abstract InternalCacheKeyInvocationContext<? extends Annotation> createCacheKeyInvocationContextImpl(StaticCacheKeyInvocationContext<? extends Annotation> staticCacheKeyInvocationContext,
                                                                                          I invocation)

Create the cache key invocation context for the provided static context and intercepted method invocation

Parameters:

staticCacheKeyInvocationContext - The static key context information about the method

invocation - The intercepted method invocation

Returns:

The cache invocation context

getCacheInvocationContext

public InternalCacheInvocationContext<? extends Annotation> getCacheInvocationContext(I invocation)

Get the AbstractInternalCacheInvocationContext for the invocation

Specified by:

getCacheInvocationContext in interface CacheContextSource<I>

Parameters:

invocation - The CDI invocation context

Returns:

The cache invocation context

createCacheInvocationContextImpl

protected abstract InternalCacheInvocationContext<? extends Annotation> createCacheInvocationContextImpl(StaticCacheInvocationContext<? extends Annotation> staticCacheInvocationContext,
                                                                                    I invocation)

Create the cache invocation context for the provided static context and intercepted method invocation

Parameters:

staticCacheInvocationContext - The static context information about the method

invocation - The intercepted method invocation

Returns:

The cache invocation context

getAnnotation

protected <T extends Annotation> T getAnnotation(Class<T> annotationClass,
                                     Method method,
                                     Class<? extends Object> targetClass)

Get the concrete annotation object for the method that will be invoked on the target class.

Subclasses may override this to provide their own annotation resolution logic, the default implementation uses Method.getAnnotation(Class)

Parameters:

annotationClass - The annotation class

method - Target method

targetClass - Target Class

Returns:

The concrete annotation from the method

getMethodDetails

public StaticCacheInvocationContext<? extends Annotation> getMethodDetails(Method method,
                                                                  Class<? extends Object> targetClass)

Get detailed data about an annotated method for a specific targeted class

Specified by:

getMethodDetails in interface CacheContextSource<I>

Parameters:

method - The method that to get details for

targetClass - The class that is being targeted with the invocation

Returns:

The detailed method data

Throws:

AnnotationFormatError - if an invalid combination of annotations exist on the method

getTargetClass

protected abstract Class<?> getTargetClass(I invocation)

Parameters:

invocation -

getMethod

protected abstract Method getMethod(I invocation)

Parameters:

invocation -

createCacheMethodDetails

protected <A extends Annotation> CacheMethodDetails<A> createCacheMethodDetails(A cacheAnnotation,
                                                                    CacheDefaults cacheDefaultsAnnotation,
                                                                    String methodCacheName,
                                                                    Method method,
                                                                    Class<? extends Object> targetClass)

Create CacheMethodDetails to describe the annotated method

Parameters:

cacheAnnotation - The annotation

cacheDefaultsAnnotation - The class level defaults annotation

method - The annotated method

targetClass - The intercepted class

Returns:

The cache method details

createCacheResultMethodDetails

protected CacheResultMethodDetails createCacheResultMethodDetails(CacheResult cacheResultAnnotation,
                                                      CacheDefaults cacheDefaultsAnnotation,
                                                      Method method,
                                                      Class<? extends Object> targetClass)

Create a StaticCacheInvocationContext implementation specific to the CacheResult annotated method

Parameters:

cacheResultAnnotation - The annotation on the method

cacheDefaultsAnnotation - The defaults annotation for the class, if it exists

method - The annotated method

targetClass - The intercepted class

Returns:

Details on the annotated method

createCachePutMethodDetails

protected CachePutMethodDetails createCachePutMethodDetails(CachePut cachePutAnnotation,
                                                CacheDefaults cacheDefaultsAnnotation,
                                                Method method,
                                                Class<? extends Object> targetClass)

Create a StaticCacheInvocationContext implementation specific to the CachePut annotated method

Parameters:

cachePutAnnotation - The annotation on the method

cacheDefaultsAnnotation - The defaults annotation for the class, if it exists

method - The annotated method

targetClass - The intercepted class

Returns:

Details on the annotated method

createCacheRemoveEntryMethodDetails

protected CacheRemoveEntryMethodDetails createCacheRemoveEntryMethodDetails(CacheRemove cacheRemoveAnnotation,
                                                                CacheDefaults cacheDefaultsAnnotation,
                                                                Method method,
                                                                Class<? extends Object> targetClass)

Create a StaticCacheInvocationContext implementation specific to the CacheRemove annotated method

Parameters:

cacheRemoveAnnotation - The annotation on the method

cacheDefaultsAnnotation - The defaults annotation for the class, if it exists

method - The annotated method

targetClass - The intercepted class

Returns:

Details on the annotated method

createCacheRemoveAllMethodDetails

protected CacheRemoveAllMethodDetails createCacheRemoveAllMethodDetails(CacheRemoveAll cacheRemoveAllAnnotation,
                                                            CacheDefaults cacheDefaultsAnnotation,
                                                            Method method,
                                                            Class<? extends Object> targetClass)

Create a StaticCacheInvocationContext implementation specific to the CacheRemoveAll annotated method

Parameters:

cacheRemoveAllAnnotation - The annotation on the method

cacheDefaultsAnnotation - The defaults annotation for the class, if it exists

method - The annotated method

targetClass - The intercepted class

Returns:

Details on the annotated method

getMethodAnnotations

protected Set<Annotation> getMethodAnnotations(Method method)

Get an immutable set of all annotations on the method

getParameterDetails

protected org.jsr107.ri.annotations.AbstractCacheLookupUtil.ParameterDetails getParameterDetails(Method method,
                                                                                     boolean cacheValueAllowed)

Parse the parameters for a Method and create immutable CacheParameterDetails lists

Parameters:

method - The method to get parameter detail information for

cacheValueAllowed - If the CacheValue annotation is legal for this method

Returns:

a ParameterDetails object, the lists it contains must be immutable.

getObjectByType

protected abstract <T> T getObjectByType(Class<T> type)

Used to load CacheKeyGenerator and CacheResolverFactory instances by type

getDefaultCacheKeyGenerator

protected abstract CacheKeyGenerator getDefaultCacheKeyGenerator()

Returns:

The default CacheKeyGenerator implementation to use

getDefaultCacheResolverFactory

protected abstract CacheResolverFactory getDefaultCacheResolverFactory()

Returns:

The default CacheKeyGenerator implementation to use

getCacheKeyGenerator

protected CacheKeyGenerator getCacheKeyGenerator(Class<? extends CacheKeyGenerator> cacheKeyGeneratorType,
                                     CacheDefaults cacheDefaultsAnnotation)

Get the cache key generator based on the requested type and the defaults

Parameters:

cacheKeyGeneratorType - Requested key generator type

cacheDefaultsAnnotation - Defaults data

Returns:

The key generator to use

getCacheResolverFactory

protected CacheResolverFactory getCacheResolverFactory(Class<? extends CacheResolverFactory> cacheResolverFactoryType,
                                           CacheDefaults cacheDefaultsAnnotation)

Get the cache resolver factory based on the requested type and the defaults.

Parameters:

cacheResolverFactoryType - Requested resolver factory type

cacheDefaultsAnnotation - Defaults data

Returns:

The cache resolver to use

resolveCacheName

protected String resolveCacheName(String methodCacheName,
                      CacheDefaults cacheDefaultsAnnotation,
                      Method method,
                      Class<? extends Object> targetClass)

Determine the cache name to use based on the method and class level annotations

Parameters:

methodCacheName - The cache name specified by the method level annotation

cacheDefaultsAnnotation - The class level cache defaults

method - The annotated method

targetClass - The target class, if not null a default cache name will be generated if no name is specified

Returns:

The resolved cache name

Throws:

AnnotationFormatError - If target is null and no cache name is specified in the method or class level annotations