org.springframework.cache.jcache.interceptor

Class AnnotationJCacheOperationSource

java.lang.Object

org.springframework.cache.jcache.interceptor.AbstractFallbackJCacheOperationSource

org.springframework.cache.jcache.interceptor.AnnotationJCacheOperationSource

All Implemented Interfaces:

JCacheOperationSource

Direct Known Subclasses:

DefaultJCacheOperationSource

public abstract class AnnotationJCacheOperationSource
extends AbstractFallbackJCacheOperationSource

Implementation of the JCacheOperationSource interface that reads the JSR-107 CacheResult, CachePut, CacheRemove and CacheRemoveAll annotations.

Since:

4.1

Author:

Stephane Nicoll

Field Summary

Fields inherited from class org.springframework.cache.jcache.interceptor.AbstractFallbackJCacheOperationSource

logger

Constructor Summary

Constructors

Constructor and Description
AnnotationJCacheOperationSource()

Method Summary

Modifier and Type	Method and Description
private int	countNonNull(java.lang.Object... instances)
protected CachePutOperation	createCachePutOperation(java.lang.reflect.Method method, CacheDefaults defaults, CachePut ann)
protected CacheRemoveAllOperation	createCacheRemoveAllOperation(java.lang.reflect.Method method, CacheDefaults defaults, CacheRemoveAll ann)
protected CacheRemoveOperation	createCacheRemoveOperation(java.lang.reflect.Method method, CacheDefaults defaults, CacheRemove ann)
protected CacheResultOperation	createCacheResultOperation(java.lang.reflect.Method method, CacheDefaults defaults, CacheResult ann)
private <A extends java.lang.annotation.Annotation> <any>	createMethodDetails(java.lang.reflect.Method method, A annotation, java.lang.String cacheName)
protected java.lang.String	determineCacheName(java.lang.reflect.Method method, CacheDefaults defaults, java.lang.String candidate)
protected CacheResolverFactory	determineCacheResolverFactory(CacheDefaults defaults, java.lang.Class<? extends CacheResolverFactory> candidate)
protected KeyGenerator	determineKeyGenerator(CacheDefaults defaults, java.lang.Class<? extends CacheKeyGenerator> candidate)
protected JCacheOperation<?>	findCacheOperation(java.lang.reflect.Method method, java.lang.Class<?> targetType) Subclasses need to implement this to return the caching operation for the given method, if any.
protected java.lang.String	generateDefaultCacheName(java.lang.reflect.Method method) Generate a default cache name for the specified Method.
protected abstract <T> T	getBean(java.lang.Class<T> type) Locate or create an instance of the specified cache strategy type.
protected CacheDefaults	getCacheDefaults(java.lang.reflect.Method method, java.lang.Class<?> targetType)
protected CacheResolver	getCacheResolver(CacheResolverFactory factory, <any> details)
protected abstract CacheResolver	getDefaultCacheResolver() Return the default CacheResolver if none is set.
protected abstract CacheResolver	getDefaultExceptionCacheResolver() Return the default exception CacheResolver if none is set.
protected abstract KeyGenerator	getDefaultKeyGenerator() Return the default KeyGenerator if none is set.
protected CacheResolver	getExceptionCacheResolver(CacheResolverFactory factory, <any> details)

Methods inherited from class org.springframework.cache.jcache.interceptor.AbstractFallbackJCacheOperationSource

allowPublicMethodsOnly, getCacheOperation

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationJCacheOperationSource

public AnnotationJCacheOperationSource()

Method Detail

findCacheOperation

protected JCacheOperation<?> findCacheOperation(java.lang.reflect.Method method,
                                                @Nullable
                                                java.lang.Class<?> targetType)

Description copied from class: AbstractFallbackJCacheOperationSource

Subclasses need to implement this to return the caching operation for the given method, if any.

Specified by:

findCacheOperation in class AbstractFallbackJCacheOperationSource

Parameters:

method - the method to retrieve the operation for

targetType - the target class

Returns:

the cache operation associated with this method (or null if none)

getCacheDefaults

@Nullable
protected CacheDefaults getCacheDefaults(java.lang.reflect.Method method,
                                                   @Nullable
                                                   java.lang.Class<?> targetType)

createCacheResultOperation

protected CacheResultOperation createCacheResultOperation(java.lang.reflect.Method method,
                                                          @Nullable
                                                          CacheDefaults defaults,
                                                          CacheResult ann)

createCachePutOperation

protected CachePutOperation createCachePutOperation(java.lang.reflect.Method method,
                                                    @Nullable
                                                    CacheDefaults defaults,
                                                    CachePut ann)

createCacheRemoveOperation

protected CacheRemoveOperation createCacheRemoveOperation(java.lang.reflect.Method method,
                                                          @Nullable
                                                          CacheDefaults defaults,
                                                          CacheRemove ann)

createCacheRemoveAllOperation

protected CacheRemoveAllOperation createCacheRemoveAllOperation(java.lang.reflect.Method method,
                                                                @Nullable
                                                                CacheDefaults defaults,
                                                                CacheRemoveAll ann)

createMethodDetails

private <A extends java.lang.annotation.Annotation> <any> createMethodDetails(java.lang.reflect.Method method,
                                                                              A annotation,
                                                                              java.lang.String cacheName)

getCacheResolver

protected CacheResolver getCacheResolver(@Nullable
                                         CacheResolverFactory factory,
                                         <any> details)

getExceptionCacheResolver

protected CacheResolver getExceptionCacheResolver(@Nullable
                                                  CacheResolverFactory factory,
                                                  <any> details)

determineCacheResolverFactory

@Nullable
protected CacheResolverFactory determineCacheResolverFactory(@Nullable
                                                                       CacheDefaults defaults,
                                                                       java.lang.Class<? extends CacheResolverFactory> candidate)

determineKeyGenerator

protected KeyGenerator determineKeyGenerator(@Nullable
                                             CacheDefaults defaults,
                                             java.lang.Class<? extends CacheKeyGenerator> candidate)

determineCacheName

protected java.lang.String determineCacheName(java.lang.reflect.Method method,
                                              @Nullable
                                              CacheDefaults defaults,
                                              java.lang.String candidate)

generateDefaultCacheName

protected java.lang.String generateDefaultCacheName(java.lang.reflect.Method method)

Generate a default cache name for the specified Method.

Parameters:

method - the annotated method

Returns:

the default cache name, according to JSR-107

countNonNull

private int countNonNull(java.lang.Object... instances)

getBean

protected abstract <T> T getBean(java.lang.Class<T> type)

Locate or create an instance of the specified cache strategy type.

Parameters:

type - the type of the bean to manage

Returns:

the required bean

getDefaultCacheResolver

protected abstract CacheResolver getDefaultCacheResolver()

Return the default CacheResolver if none is set.

getDefaultExceptionCacheResolver

protected abstract CacheResolver getDefaultExceptionCacheResolver()

Return the default exception CacheResolver if none is set.

getDefaultKeyGenerator

protected abstract KeyGenerator getDefaultKeyGenerator()

Return the default KeyGenerator if none is set.