grails.plugin.cache

Class GrailsAnnotationCacheOperationSource

java.lang.Object

grails.plugin.cache.GrailsAnnotationCacheOperationSource

All Implemented Interfaces:

java.io.Serializable, org.springframework.cache.interceptor.CacheOperationSource

public class GrailsAnnotationCacheOperationSource
extends java.lang.Object
implements org.springframework.cache.interceptor.CacheOperationSource, java.io.Serializable

getCacheOperations is called when beans are initialized and also from PageFragmentCachingFilter during requests; the filter needs annotations on controllers but if the standard lookup includes controllers, the return values from the controller method calls are cached unnecessarily. Based on org.springframework.cache.annotation.AnnotationCacheOperationSource.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	GrailsAnnotationCacheOperationSource.DefaultCacheKey Default cache key for the CacheOperation cache.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set<org.springframework.cache.annotation.CacheAnnotationParser>	annotationParsers
protected grails.core.GrailsApplication	application
protected java.util.Map<java.lang.Object,java.util.Collection<org.springframework.cache.interceptor.CacheOperation>>	attributeCache Cache of CacheOperations, keyed by DefaultCacheKey (Method + target Class).
static java.lang.String	BEAN_NAME
protected org.slf4j.Logger	logger
protected static java.util.Collection<org.springframework.cache.interceptor.CacheOperation>	NULL_CACHING_ATTRIBUTE Canonical value held in cache to indicate no caching attribute was found for this method and we don't need to look again.
protected boolean	publicMethodsOnly

Constructor Summary

Constructors

Constructor and Description
GrailsAnnotationCacheOperationSource() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected java.util.Collection<org.springframework.cache.interceptor.CacheOperation>	computeCacheOperations(java.lang.reflect.Method method, java.lang.Class<?> targetClass)
protected java.util.Collection<org.springframework.cache.interceptor.CacheOperation>	doGetCacheOperations(java.lang.reflect.Method method, java.lang.Class<?> targetClass) Determine the caching attribute for this method invocation.
protected java.util.Collection<org.springframework.cache.interceptor.CacheOperation>	findCacheOperations(java.lang.Class<?> clazz)
protected java.util.Collection<org.springframework.cache.interceptor.CacheOperation>	findCacheOperations(java.lang.reflect.Method method)
protected java.lang.Object	getCacheKey(java.lang.reflect.Method method, java.lang.Class<?> targetClass) Determine a cache key for the given method and target class.
java.util.Collection<org.springframework.cache.interceptor.CacheOperation>	getCacheOperations(java.lang.reflect.Method method, java.lang.Class<?> targetClass)
java.util.Collection<org.springframework.cache.interceptor.CacheOperation>	getCacheOperations(java.lang.reflect.Method method, java.lang.Class<?> targetClass, boolean includeControllers)
protected boolean	isControllerClass(java.lang.Class<?> targetClass)
void	reset() For dev mode when rediscovering annotations is needed.
void	setAllowPublicMethodsOnly(boolean allow) Dependency injection for whether to only consider public methods
void	setGrailsApplication(grails.core.GrailsApplication grailsApplication) Dependency injection for the grails application.

Methods inherited from class java.lang.Object

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

Field Detail

BEAN_NAME

public static final java.lang.String BEAN_NAME

See Also:

Constant Field Values

NULL_CACHING_ATTRIBUTE

protected static final java.util.Collection<org.springframework.cache.interceptor.CacheOperation> NULL_CACHING_ATTRIBUTE

Canonical value held in cache to indicate no caching attribute was found for this method and we don't need to look again.

application

protected grails.core.GrailsApplication application

publicMethodsOnly

protected boolean publicMethodsOnly

logger

protected org.slf4j.Logger logger

annotationParsers

protected final java.util.Set<org.springframework.cache.annotation.CacheAnnotationParser> annotationParsers

attributeCache

protected final java.util.Map<java.lang.Object,java.util.Collection<org.springframework.cache.interceptor.CacheOperation>> attributeCache

Cache of CacheOperations, keyed by DefaultCacheKey (Method + target Class).

Constructor Detail

GrailsAnnotationCacheOperationSource

public GrailsAnnotationCacheOperationSource()

Constructor.

Method Detail

getCacheOperations

public java.util.Collection<org.springframework.cache.interceptor.CacheOperation> getCacheOperations(java.lang.reflect.Method method,
                                                                                            java.lang.Class<?> targetClass,
                                                                                            boolean includeControllers)

getCacheOperations

public java.util.Collection<org.springframework.cache.interceptor.CacheOperation> getCacheOperations(java.lang.reflect.Method method,
                                                                                            java.lang.Class<?> targetClass)

Specified by:

getCacheOperations in interface org.springframework.cache.interceptor.CacheOperationSource

doGetCacheOperations

protected java.util.Collection<org.springframework.cache.interceptor.CacheOperation> doGetCacheOperations(java.lang.reflect.Method method,
                                                                                              java.lang.Class<?> targetClass)

Determine the caching attribute for this method invocation.

Defaults to the class's caching attribute if no method attribute is found.

Parameters:

method - the method for the current invocation (never null)

targetClass - the target class for this invocation (may be null)

Returns:

CacheOperation for this method, or null if the method is not cacheable

reset

public void reset()

For dev mode when rediscovering annotations is needed.

getCacheKey

protected java.lang.Object getCacheKey(java.lang.reflect.Method method,
                           java.lang.Class<?> targetClass)

Determine a cache key for the given method and target class.

Must not produce same key for overloaded methods. Must produce same key for different instances of the same method.

Parameters:

method - the method (never null)

targetClass - the target class (may be null)

Returns:

the cache key (never null)

computeCacheOperations

protected java.util.Collection<org.springframework.cache.interceptor.CacheOperation> computeCacheOperations(java.lang.reflect.Method method,
                                                                                                java.lang.Class<?> targetClass)

findCacheOperations

protected java.util.Collection<org.springframework.cache.interceptor.CacheOperation> findCacheOperations(java.lang.Class<?> clazz)

findCacheOperations

protected java.util.Collection<org.springframework.cache.interceptor.CacheOperation> findCacheOperations(java.lang.reflect.Method method)

isControllerClass

protected boolean isControllerClass(java.lang.Class<?> targetClass)

setGrailsApplication

public void setGrailsApplication(grails.core.GrailsApplication grailsApplication)

Dependency injection for the grails application.

Parameters:

grailsApplication - the app

setAllowPublicMethodsOnly

public void setAllowPublicMethodsOnly(boolean allow)

Dependency injection for whether to only consider public methods

Parameters:

allow - allow public only