Spring Context 6.1.4 · org.springframework.cache.interceptor.CacheAspectSupport

Modifier and Type	Class and Description
private static class	CacheAspectSupport.CacheOperationCacheKey
protected class	CacheAspectSupport.CacheOperationContext A `CacheOperationInvocationContext` context for a `CacheOperation`.
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.CachePutListSubscriber Reactive Streams Subscriber collection for collecting a List to cache.
private class	CacheAspectSupport.CachePutRequest
private class	CacheAspectSupport.ReactiveCachingHandler Inner class to avoid a hard dependency on the Reactive Streams API at runtime.

Modifier and Type	Field and Description
private BeanFactory	beanFactory
private CacheOperationSource	cacheOperationSource
private SingletonSupplier<CacheResolver>	cacheResolver
private final CacheOperationExpressionEvaluator	evaluator
public static final String	IGNORE_REACTIVESTREAMS_PROPERTY_NAME System property that instructs Spring's caching infrastructure to ignore the presence of Reactive Streams, in particular Reactor's `Mono`/`Flux` in `org.springframework.cache.annotation.Cacheable` method return type declarations.
private boolean	initialized
private SingletonSupplier<KeyGenerator>	keyGenerator
protected final Log	logger
private final Map<CacheAspectSupport.CacheOperationCacheKey, CacheAspectSupport.CacheOperationMetadata>	metadataCache
private final StandardEvaluationContext	originalEvaluationContext
private final CacheAspectSupport.ReactiveCachingHandler	reactiveCachingHandler
private static final boolean	reactiveStreamsPresent
private static final boolean	shouldIgnoreReactiveStreams

Access	Constructor and Description
protected	CacheAspectSupport()

Method Summary

Modifier and Type	Method and Description
public void	afterPropertiesSet() Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Invoked by the containing `BeanFactory` after it has set all bean properties and satisfied `BeanFactoryAware`, `ApplicationContextAware` etc. This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.
public void	afterSingletonsInstantiated() Implements org.springframework.beans.factory.SmartInitializingSingleton.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(Collection<CacheAspectSupport.CacheOperationContext> the contexts to handle contexts, Object the result value result, Collection<CacheAspectSupport.CachePutRequest> the collection to update putRequests) Collect a `CachePutRequest` for every `CacheOperation` using the specified result value.
public void	configure(Supplier<CacheErrorHandler> errorHandler, Supplier<KeyGenerator> keyGenerator, Supplier<CacheResolver> cacheResolver, Supplier<CacheManager> cacheManager) Configure this aspect with the given error handler, key generator and cache resolver/manager suppliers, applying the corresponding default if a supplier is not resolvable.
private Object	evaluate(Object cacheHit, CacheOperationInvoker invoker, Method method, CacheAspectSupport.CacheOperationContexts contexts)
protected Object	execute(CacheOperationInvoker invoker, Object target, Method method, Object[] args)
private Object	execute(CacheOperationInvoker invoker, Method method, CacheAspectSupport.CacheOperationContexts contexts)
private Object	executeSynchronized(CacheOperationInvoker invoker, Method method, CacheAspectSupport.CacheOperationContexts contexts)
private Object	Returns: a `Cache.ValueWrapper` holding the cached value, or `null` if none is found findCachedValue(CacheOperationInvoker invoker, Method method, CacheAspectSupport.CacheOperationContexts the cacheable operations contexts) Find a cached value only for `CacheableOperation` that passes the condition.
private Object	findInCaches(CacheAspectSupport.CacheOperationContext context, Object key, CacheOperationInvoker invoker, Method method, CacheAspectSupport.CacheOperationContexts contexts)
private Object	generateKey(CacheAspectSupport.CacheOperationContext context, Object result)
protected <T> T	Returns: the bean matching the expected type, qualified by the given name getBean(String the name of the bean, as defined by the cache operation name, Class<T> the type expected by the operation's service reference serviceType) Retrieve a bean with the specified name and type.
protected CacheAspectSupport.CacheOperationMetadata	Returns: the resolved metadata for the operation getCacheOperationMetadata(CacheOperation the operation operation, Method the method on which the operation is invoked method, Class<?> the target type targetClass) Return the `CacheOperationMetadata` for the specified operation.
public CacheOperationSource	getCacheOperationSource() Return the CacheOperationSource for this cache aspect.
public CacheResolver	getCacheResolver() Return the default `CacheResolver` that this cache aspect delegates to.
protected Collection<? extends Cache>	getCaches(CacheOperationInvocationContext<CacheOperation> context, CacheResolver cacheResolver)
public KeyGenerator	getKeyGenerator() Return the default `KeyGenerator` that this cache aspect delegates to.
protected CacheAspectSupport.CacheOperationContext	getOperationContext(CacheOperation operation, Method method, Object[] args, Object target, Class<?> targetClass)
private boolean	hasCachePut(CacheAspectSupport.CacheOperationContexts contexts)
protected Object	Returns: the result of the invocation invokeOperation(CacheOperationInvoker the invoker handling the operation being cached invoker) Execute the underlying operation (typically in case of cache miss) and return the result of the invocation.
private boolean	isConditionPassing(CacheAspectSupport.CacheOperationContext context, Object result)
private void	logInvalidating(CacheAspectSupport.CacheOperationContext context, CacheEvictOperation operation, Object key)
protected String	Returns: log message identifying this method methodIdentification(Method the method we're interested in method, Class<?> class the method is on targetClass) Convenience method to return a String representation of this Method for use in logging.
private void	performCacheEvicts(List<CacheAspectSupport.CacheOperationContext> contexts, Object result)
private Object	processCacheEvicts(Collection<CacheAspectSupport.CacheOperationContext> contexts, boolean beforeInvocation, Object result)
public void	setBeanFactory(BeanFactory owning BeanFactory (never `null`). The bean can immediately call methods on the factory. beanFactory) Implements org.springframework.beans.factory.BeanFactoryAware.setBeanFactory. Set the containing `BeanFactory` for `CacheManager` and other service lookups.
public void	setCacheManager(CacheManager cacheManager) Set the `CacheManager` to use to create a default `CacheResolver`.
public void	setCacheOperationSource(CacheOperationSource cacheOperationSource) Set the CacheOperationSource for this cache aspect.
public void	setCacheOperationSources(CacheOperationSource... cacheOperationSources) Set one or more cache operation sources which are used to find the cache attributes.
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.
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.
private Object	unwrapCacheValue(Object cacheValue)
private Object	unwrapReturnValue(Object returnValue)
private Object	wrapCacheValue(Method method, Object cacheValue)

Inherited from org.springframework.cache.interceptor.AbstractCacheInvoker:: doClear doEvict doGet doPut getErrorHandler setErrorHandler

public abstract Class CacheAspectSupport

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary