org.springframework.cache.interceptor

Class CacheAspectSupport

java.lang.Object

org.springframework.cache.interceptor.AbstractCacheInvoker

org.springframework.cache.interceptor.CacheAspectSupport

All Implemented Interfaces:

Aware, InitializingBean, SmartInitializingSingleton, ApplicationContextAware

Direct Known Subclasses:

CacheInterceptor

public abstract class CacheAspectSupport
extends AbstractCacheInvoker
implements InitializingBean, SmartInitializingSingleton, ApplicationContextAware

Base class for caching aspects, such as the CacheInterceptor or an AspectJ aspect.

This enables the underlying Spring caching infrastructure to be used easily to implement an aspect for any aspect system.

Subclasses are responsible for calling methods in this class in the correct order.

Uses the Strategy design pattern. A CacheResolver implementation will resolve the actual cache(s) to use, and a CacheOperationSource is used for determining caching operations.

A cache aspect is serializable if its CacheResolver and CacheOperationSource are serializable.

Since:

3.1

Author:

Costin Leau, Juergen Hoeller, Chris Beams, Phillip Webb, Sam Brannen, Stephane Nicoll

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	CacheAspectSupport.CacheOperationCacheKey
protected class	CacheAspectSupport.CacheOperationContext
private class	CacheAspectSupport.CacheOperationContexts
protected static class	CacheAspectSupport.CacheOperationMetadata Metadata of a cache operation that does not depend on a particular invocation which makes it a good candidate for caching.
private class	CacheAspectSupport.CachePutRequest

Field Summary

Fields

Modifier and Type	Field and Description
private ApplicationContext	applicationContext
private CacheOperationSource	cacheOperationSource
private CacheResolver	cacheResolver
private ExpressionEvaluator	evaluator
private boolean	initialized
private KeyGenerator	keyGenerator
protected Log	logger
private java.util.Map<CacheAspectSupport.CacheOperationCacheKey,CacheAspectSupport.CacheOperationMetadata>	metadataCache Cache of CacheOperationMetadata, keyed by CacheAspectSupport.CacheOperationCacheKey.

Constructor Summary

Constructors

Constructor and Description
CacheAspectSupport()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet() Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
void	afterSingletonsInstantiated() Invoked right at the end of the singleton pre-instantiation phase, with a guarantee that all regular singleton beans have been created already.
protected void	clearMetadataCache() Clear the cached metadata.
private void	collectPutRequests(java.util.Collection<CacheAspectSupport.CacheOperationContext> contexts, java.lang.Object result, java.util.Collection<CacheAspectSupport.CachePutRequest> putRequests) Collect the CacheAspectSupport.CachePutRequest for all CacheOperation using the specified result item.
private java.lang.Object	execute(CacheOperationInvoker invoker, CacheAspectSupport.CacheOperationContexts contexts)
protected java.lang.Object	execute(CacheOperationInvoker invoker, java.lang.Object target, java.lang.reflect.Method method, java.lang.Object[] args)
private Cache.ValueWrapper	findCachedItem(java.util.Collection<CacheAspectSupport.CacheOperationContext> contexts) Find a cached item only for CacheableOperation that passes the condition.
private Cache.ValueWrapper	findInCaches(CacheAspectSupport.CacheOperationContext context, java.lang.Object key)
private java.lang.Object	generateKey(CacheAspectSupport.CacheOperationContext context, java.lang.Object result)
protected <T> T	getBean(java.lang.String beanName, java.lang.Class<T> expectedType) Return a bean with the specified name and type.
protected CacheAspectSupport.CacheOperationMetadata	getCacheOperationMetadata(CacheOperation operation, java.lang.reflect.Method method, java.lang.Class<?> targetClass) Return the CacheAspectSupport.CacheOperationMetadata for the specified operation.
CacheOperationSource	getCacheOperationSource() Return the CacheOperationSource for this cache aspect.
CacheResolver	getCacheResolver() Return the default CacheResolver that this cache aspect delegates to.
protected java.util.Collection<? extends Cache>	getCaches(CacheOperationInvocationContext<CacheOperation> context, CacheResolver cacheResolver)
KeyGenerator	getKeyGenerator() Return the default KeyGenerator that this cache aspect delegates to.
protected CacheAspectSupport.CacheOperationContext	getOperationContext(CacheOperation operation, java.lang.reflect.Method method, java.lang.Object[] args, java.lang.Object target, java.lang.Class<?> targetClass)
private java.lang.Class<?>	getTargetClass(java.lang.Object target)
private boolean	hasCachePut(CacheAspectSupport.CacheOperationContexts contexts)
protected java.lang.Object	invokeOperation(CacheOperationInvoker invoker) Execute the underlying operation (typically in case of cache miss) and return the result of the invocation.
private boolean	isConditionPassing(CacheAspectSupport.CacheOperationContext context, java.lang.Object result)
private void	logInvalidating(CacheAspectSupport.CacheOperationContext context, CacheEvictOperation operation, java.lang.Object key)
protected java.lang.String	methodIdentification(java.lang.reflect.Method method, java.lang.Class<?> targetClass) Convenience method to return a String representation of this Method for use in logging.
private void	performCacheEvict(CacheAspectSupport.CacheOperationContext context, CacheEvictOperation operation, java.lang.Object result)
private void	processCacheEvicts(java.util.Collection<CacheAspectSupport.CacheOperationContext> contexts, boolean beforeInvocation, java.lang.Object result)
void	setApplicationContext(ApplicationContext applicationContext) Set the ApplicationContext that this object runs in.
void	setCacheManager(CacheManager cacheManager) Set the CacheManager to use to create a default CacheResolver.
void	setCacheOperationSources(CacheOperationSource... cacheOperationSources) Set one or more cache operation sources which are used to find the cache attributes.
void	setCacheResolver(CacheResolver cacheResolver) Set the default CacheResolver that this cache aspect should delegate to if no specific cache resolver has been set for the operation.
void	setKeyGenerator(KeyGenerator keyGenerator) Set the default KeyGenerator that this cache aspect should delegate to if no specific key generator has been set for the operation.

Methods inherited from class org.springframework.cache.interceptor.AbstractCacheInvoker

doClear, doEvict, doGet, doPut, getErrorHandler, setErrorHandler

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final Log logger

metadataCache

private final java.util.Map<CacheAspectSupport.CacheOperationCacheKey,CacheAspectSupport.CacheOperationMetadata> metadataCache

Cache of CacheOperationMetadata, keyed by CacheAspectSupport.CacheOperationCacheKey.

evaluator

private final ExpressionEvaluator evaluator

cacheOperationSource

private CacheOperationSource cacheOperationSource

keyGenerator

private KeyGenerator keyGenerator

cacheResolver

private CacheResolver cacheResolver

applicationContext

private ApplicationContext applicationContext

initialized

private boolean initialized

Constructor Detail

CacheAspectSupport

public CacheAspectSupport()

Method Detail

setCacheOperationSources

public void setCacheOperationSources(CacheOperationSource... cacheOperationSources)

Set one or more cache operation sources which are used to find the cache attributes. If more than one source is provided, they will be aggregated using a CompositeCacheOperationSource.

getCacheOperationSource

public CacheOperationSource getCacheOperationSource()

Return the CacheOperationSource for this cache aspect.

setKeyGenerator

public void setKeyGenerator(KeyGenerator keyGenerator)

Set the default KeyGenerator that this cache aspect should delegate to if no specific key generator has been set for the operation.

The default is a SimpleKeyGenerator

getKeyGenerator

public KeyGenerator getKeyGenerator()

Return the default KeyGenerator that this cache aspect delegates to.

setCacheManager

public void setCacheManager(CacheManager cacheManager)

Set the CacheManager to use to create a default CacheResolver. Replace the current CacheResolver, if any.

See Also:

setCacheResolver(CacheResolver), SimpleCacheResolver

setCacheResolver

public void setCacheResolver(CacheResolver cacheResolver)

Set the default CacheResolver that this cache aspect should delegate to if no specific cache resolver has been set for the operation.

The default resolver resolves the caches against their names and the default cache manager.

See Also:

setCacheManager(org.springframework.cache.CacheManager), SimpleCacheResolver

getCacheResolver

public CacheResolver getCacheResolver()

Return the default CacheResolver that this cache aspect delegates to.

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)

Description copied from interface: ApplicationContextAware

Set the ApplicationContext that this object runs in. Normally this call will be used to initialize the object.

Invoked after population of normal bean properties but before an init callback such as InitializingBean.afterPropertiesSet() or a custom init-method. Invoked after ResourceLoaderAware.setResourceLoader(org.springframework.core.io.ResourceLoader), ApplicationEventPublisherAware.setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher) and MessageSourceAware, if applicable.

Specified by:

setApplicationContext in interface ApplicationContextAware

Parameters:

applicationContext - the ApplicationContext object to be used by this object

See Also:

BeanInitializationException

afterPropertiesSet

public void afterPropertiesSet()

Description copied from interface: InitializingBean

Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).

This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.

Specified by:

afterPropertiesSet in interface InitializingBean

afterSingletonsInstantiated

public void afterSingletonsInstantiated()

Description copied from interface: SmartInitializingSingleton

Invoked right at the end of the singleton pre-instantiation phase, with a guarantee that all regular singleton beans have been created already. ListableBeanFactory.getBeansOfType(java.lang.Class<T>) calls within this method won't trigger accidental side effects during bootstrap.

NOTE: This callback won't be triggered for singleton beans lazily initialized on demand after BeanFactory bootstrap, and not for any other bean scope either. Carefully use it for beans with the intended bootstrap semantics only.

Specified by:

afterSingletonsInstantiated in interface SmartInitializingSingleton

methodIdentification

protected java.lang.String methodIdentification(java.lang.reflect.Method method,
                                                java.lang.Class<?> targetClass)

Convenience method to return a String representation of this Method for use in logging. Can be overridden in subclasses to provide a different identifier for the given method.

Parameters:

method - the method we're interested in

targetClass - class the method is on

Returns:

log message identifying this method

See Also:

ClassUtils.getQualifiedMethodName(java.lang.reflect.Method)

getCaches

protected java.util.Collection<? extends Cache> getCaches(CacheOperationInvocationContext<CacheOperation> context,
                                                          CacheResolver cacheResolver)

getOperationContext

protected CacheAspectSupport.CacheOperationContext getOperationContext(CacheOperation operation,
                                                                       java.lang.reflect.Method method,
                                                                       java.lang.Object[] args,
                                                                       java.lang.Object target,
                                                                       java.lang.Class<?> targetClass)

getCacheOperationMetadata

protected CacheAspectSupport.CacheOperationMetadata getCacheOperationMetadata(CacheOperation operation,
                                                                              java.lang.reflect.Method method,
                                                                              java.lang.Class<?> targetClass)

Return the CacheAspectSupport.CacheOperationMetadata for the specified operation.

Resolve the CacheResolver and the KeyGenerator to be used for the operation.

Parameters:

operation - the operation

method - the method on which the operation is invoked

targetClass - the target type

Returns:

the resolved metadata for the operation

getBean

protected <T> T getBean(java.lang.String beanName,
                        java.lang.Class<T> expectedType)

Return a bean with the specified name and type. Used to resolve services that are referenced by name in a CacheOperation.

Parameters:

beanName - the name of the bean, as defined by the operation

expectedType - type type for the bean

Returns:

the bean matching that name

Throws:

NoSuchBeanDefinitionException - if such bean does not exist

See Also:

CacheOperation.keyGenerator, CacheOperation.cacheManager, CacheOperation.cacheResolver

clearMetadataCache

protected void clearMetadataCache()

Clear the cached metadata.

execute

protected java.lang.Object execute(CacheOperationInvoker invoker,
                                   java.lang.Object target,
                                   java.lang.reflect.Method method,
                                   java.lang.Object[] args)

invokeOperation

protected java.lang.Object invokeOperation(CacheOperationInvoker invoker)

Execute the underlying operation (typically in case of cache miss) and return the result of the invocation. If an exception occurs it will be wrapped in a CacheOperationInvoker.ThrowableWrapper: the exception can be handled or modified but it must be wrapped in a CacheOperationInvoker.ThrowableWrapper as well.

Parameters:

invoker - the invoker handling the operation being cached

Returns:

the result of the invocation

See Also:

CacheOperationInvoker.invoke()

getTargetClass

private java.lang.Class<?> getTargetClass(java.lang.Object target)

execute

private java.lang.Object execute(CacheOperationInvoker invoker,
                                 CacheAspectSupport.CacheOperationContexts contexts)

hasCachePut

private boolean hasCachePut(CacheAspectSupport.CacheOperationContexts contexts)

processCacheEvicts

private void processCacheEvicts(java.util.Collection<CacheAspectSupport.CacheOperationContext> contexts,
                                boolean beforeInvocation,
                                java.lang.Object result)

performCacheEvict

private void performCacheEvict(CacheAspectSupport.CacheOperationContext context,
                               CacheEvictOperation operation,
                               java.lang.Object result)

logInvalidating

private void logInvalidating(CacheAspectSupport.CacheOperationContext context,
                             CacheEvictOperation operation,
                             java.lang.Object key)

findCachedItem

private Cache.ValueWrapper findCachedItem(java.util.Collection<CacheAspectSupport.CacheOperationContext> contexts)

Find a cached item only for CacheableOperation that passes the condition.

Parameters:

contexts - the cacheable operations

Returns:

a Cache.ValueWrapper holding the cached item, or null if none is found

collectPutRequests

private void collectPutRequests(java.util.Collection<CacheAspectSupport.CacheOperationContext> contexts,
                                java.lang.Object result,
                                java.util.Collection<CacheAspectSupport.CachePutRequest> putRequests)

Collect the CacheAspectSupport.CachePutRequest for all CacheOperation using the specified result item.

Parameters:

contexts - the contexts to handle

result - the result item (never null)

putRequests - the collection to update

findInCaches

private Cache.ValueWrapper findInCaches(CacheAspectSupport.CacheOperationContext context,
                                        java.lang.Object key)

isConditionPassing

private boolean isConditionPassing(CacheAspectSupport.CacheOperationContext context,
                                   java.lang.Object result)

generateKey

private java.lang.Object generateKey(CacheAspectSupport.CacheOperationContext context,
                                     java.lang.Object result)