public abstract class

AbstractFallbackCacheDefinitionSource

extends Object
implements CacheDefinitionSource
java.lang.Object
   ↳ org.springframework.cache.interceptor.AbstractFallbackCacheDefinitionSource
Known Direct Subclasses

Class Overview

Abstract implementation of CacheDefinition 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.

Summary

Fields
protected final Log logger Logger available to subclasses.
Public Constructors
AbstractFallbackCacheDefinitionSource()
Public Methods
CacheDefinition getCacheDefinition(Method method, Class<?> targetClass)
Determine the caching attribute for this method invocation.
Protected Methods
boolean allowPublicMethodsOnly()
Should only public methods be allowed to have caching semantics?

The default implementation returns false.

abstract CacheDefinition findCacheDefinition(Class<?> clazz)
Subclasses need to implement this to return the caching attribute for the given class, if any.
abstract CacheDefinition findCacheOperation(Method method)
Subclasses need to implement this to return the caching attribute for the given method, if any.
Object getCacheKey(Method method, Class<?> targetClass)
Determine a cache key for the given method and target class.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.springframework.cache.interceptor.CacheDefinitionSource

Fields

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.

Public Constructors

public AbstractFallbackCacheDefinitionSource ()

Public Methods

public CacheDefinition getCacheDefinition (Method method, 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

Protected Methods

protected boolean allowPublicMethodsOnly ()

Should only public methods be allowed to have caching semantics?

The default implementation returns false.

protected abstract CacheDefinition findCacheDefinition (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)

protected abstract CacheDefinition findCacheOperation (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)

protected Object getCacheKey (Method method, 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)