org.springframework.cache.interceptor

Class AbstractFallbackCacheOperationSource

  • java.lang.Object
    • org.springframework.cache.interceptor.AbstractFallbackCacheOperationSource
  • All Implemented Interfaces:
    CacheOperationSource
    Direct Known Subclasses:
    AnnotationCacheOperationSource


    public abstract class AbstractFallbackCacheOperationSource
    extends java.lang.Object
    implements CacheOperationSource
    Abstract implementation of CacheOperation that caches attributes for methods and implements a fallback policy: 1. specific target method; 2. target class; 3. declaring method; 4. declaring class/interface.

    Defaults to using the target class's caching attribute if none is associated with the target method. Any caching attribute associated with the target method completely overrides a class caching attribute. If none found on the target class, the interface that the invoked method has been called through (in case of a JDK proxy) will be checked.

    This implementation caches attributes by method after they are first used. If it is ever desirable to allow dynamic changing of cacheable attributes (which is very unlikely), caching could be made configurable.

    Since:
    3.1
    Author:
    Costin Leau, Juergen Hoeller
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      protected Log logger
      Logger available to subclasses.
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method and Description
      protected boolean allowPublicMethodsOnly()
      Should only public methods be allowed to have caching semantics?
      protected abstract java.util.Collection<CacheOperation> findCacheOperations(java.lang.Class<?> clazz)
      Subclasses need to implement this to return the caching attribute for the given class, if any.
      protected abstract java.util.Collection<CacheOperation> findCacheOperations(java.lang.reflect.Method method)
      Subclasses need to implement this to return the caching attribute for the given method, if any.
      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<CacheOperation> getCacheOperations(java.lang.reflect.Method method, java.lang.Class<?> targetClass)
      Determine the caching attribute for this method invocation.
      • 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
        Logger available to subclasses.

        As this base class is not marked Serializable, the logger will be recreated after serialization - provided that the concrete subclass is Serializable.

    • Constructor Detail

      • AbstractFallbackCacheOperationSource

        public AbstractFallbackCacheOperationSource()
    • Method Detail

      • getCacheOperations

        @Nullable
        public java.util.Collection<CacheOperation> getCacheOperations(java.lang.reflect.Method method,
                                                                                 @Nullable
                                                                                 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.

        Specified by:
        getCacheOperations in interface CacheOperationSource
        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
      • getCacheKey

        protected java.lang.Object getCacheKey(java.lang.reflect.Method method,
                                               @Nullable
                                               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)
      • findCacheOperations

        @Nullable
        protected abstract java.util.Collection<CacheOperation> findCacheOperations(java.lang.Class<?> clazz)
        Subclasses need to implement this to return the caching attribute for the given class, if any.
        Parameters:
        clazz - the class to retrieve the attribute for
        Returns:
        all caching attribute associated with this class, or null if none
      • findCacheOperations

        @Nullable
        protected abstract java.util.Collection<CacheOperation> findCacheOperations(java.lang.reflect.Method method)
        Subclasses need to implement this to return the caching attribute for the given method, if any.
        Parameters:
        method - the method to retrieve the attribute for
        Returns:
        all caching attribute associated with this method, or null if none
      • allowPublicMethodsOnly

        protected boolean allowPublicMethodsOnly()
        Should only public methods be allowed to have caching semantics?

        The default implementation returns false.