Base class for JSR-107 caching aspects, such as the JCacheInterceptor or an AspectJ aspect.

Use the Spring caching abstraction for cache-related operations. No JSR-107 javax.cache.Cache or javax.cache.CacheManager are required to process standard JSR-107 cache annotations.

The JCacheOperationSource is used for determining caching operations

A cache aspect is serializable if its JCacheOperationSource is serializable.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	JCacheAspectSupport.CacheOperationInvokerAdapter

Field Summary

Modifier and Type	Field and Description
private JCacheOperationSource	cacheOperationSource
private CachePutInterceptor	cachePutInterceptor
private CacheRemoveAllInterceptor	cacheRemoveAllInterceptor
private CacheRemoveEntryInterceptor	cacheRemoveEntryInterceptor
private CacheResultInterceptor	cacheResultInterceptor
private boolean	initialized
protected final Log	logger

Inherited from org.springframework.cache.interceptor.AbstractCacheInvoker:: errorHandler

Constructor Summary

Access	Constructor and Description
public	JCacheAspectSupport()

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.
private CacheOperationInvocationContext<?>	createCacheOperationInvocationContext(Object target, Object[] args, JCacheOperation<?> operation)
protected Object	execute(CacheOperationInvoker invoker, Object target, Method method, Object[] args)
private Object	execute(CacheOperationInvocationContext<?> context, CacheOperationInvoker invoker)
public JCacheOperationSource	getCacheOperationSource() Return the CacheOperationSource for this cache aspect.
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.
public void	setCacheOperationSource(JCacheOperationSource cacheOperationSource) Set the CacheOperationSource for this cache aspect.

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

Field Detail

cacheOperationSource	back to summary
private JCacheOperationSource cacheOperationSource Annotations @Nullable

cachePutInterceptor	back to summary
private CachePutInterceptor cachePutInterceptor Annotations @Nullable

cacheRemoveAllInterceptor	back to summary
private CacheRemoveAllInterceptor cacheRemoveAllInterceptor Annotations @Nullable

cacheRemoveEntryInterceptor	back to summary
private CacheRemoveEntryInterceptor cacheRemoveEntryInterceptor Annotations @Nullable

cacheResultInterceptor	back to summary
private CacheResultInterceptor cacheResultInterceptor Annotations @Nullable

initialized	back to summary
private boolean initialized

logger	back to summary
protected final Log logger

Constructor Detail

JCacheAspectSupport	back to summary
public JCacheAspectSupport()

Method Detail

afterPropertiesSet back to summary

afterPropertiesSet	back to summary
public void afterPropertiesSet() Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Doc from 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. Annotations @Override

public void afterPropertiesSet()

Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Doc from 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.

Annotations

@Override

createCacheOperationInvocationContext	back to summary
private CacheOperationInvocationContext<?> createCacheOperationInvocationContext(Object target, Object[] args, JCacheOperation<?> operation) Annotations @SuppressWarnings:unchecked

execute	back to summary
protected Object execute(CacheOperationInvoker invoker, Object target, Method method, Object[] args) Annotations @Nullable

execute	back to summary
private Object execute(CacheOperationInvocationContext<?> context, CacheOperationInvoker invoker) Annotations @SuppressWarnings:unchecked @Nullable

getCacheOperationSource	back to summary
public JCacheOperationSource getCacheOperationSource() Return the CacheOperationSource for this cache aspect.

invokeOperation back to summary

invokeOperation	back to summary
protected 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 `ThrowableWrapper`: the exception can be handled or modified but it must be wrapped in a `ThrowableWrapper` as well. Parameters invoker:CacheOperationInvoker the invoker handling the operation being cached Returns:Object the result of the invocation Annotations @Nullable See Also `CacheOperationInvoker#invoke()`

protected 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 ThrowableWrapper: the exception can be handled or modified but it must be wrapped in a ThrowableWrapper as well.

Parameters

invoker:CacheOperationInvoker: the invoker handling the operation being cached

Returns:Object

the result of the invocation

Annotations

@Nullable

See Also

CacheOperationInvoker#invoke()

setCacheOperationSource	back to summary
public void setCacheOperationSource(JCacheOperationSource cacheOperationSource) Set the CacheOperationSource for this cache aspect.

org.springframework.cache.jcache.interceptor back to summary

private Class JCacheAspectSupport.CacheOperationInvokerAdapter

Class Inheritance

extends Object
implements CacheOperationInvoker

java.lang.Object
org.springframework.cache.jcache.interceptor.JCacheAspectSupport.CacheOperationInvokerAdapter

All Implemented Interfaces

org.springframework.cache.interceptor.CacheOperationInvoker

Field Summary

Modifier and Type	Field and Description
private final CacheOperationInvoker	delegate

Constructor Summary

Access	Constructor and Description
public	CacheOperationInvokerAdapter(CacheOperationInvoker delegate)

Method Summary

Modifier and Type	Method and Description
public Object	invoke() Implements org.springframework.cache.interceptor.CacheOperationInvoker.invoke. Invoke the cache operation defined by this instance.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

delegate	back to summary
private final CacheOperationInvoker delegate

Constructor Detail

CacheOperationInvokerAdapter	back to summary
public CacheOperationInvokerAdapter(CacheOperationInvoker delegate)

Method Detail

invoke back to summary

invoke	back to summary
public Object invoke() throws ThrowableWrapper Implements org.springframework.cache.interceptor.CacheOperationInvoker.invoke. Doc from org.springframework.cache.interceptor.CacheOperationInvoker.invoke. Invoke the cache operation defined by this instance. Wraps any exception that is thrown during the invocation in a `ThrowableWrapper`. Returns:Object the result of the operation Annotations @Override Exceptions ThrowableWrapper: if an error occurred while invoking the operation

public Object invoke() throws ThrowableWrapper

Implements org.springframework.cache.interceptor.CacheOperationInvoker.invoke.

Doc from org.springframework.cache.interceptor.CacheOperationInvoker.invoke.

Invoke the cache operation defined by this instance. Wraps any exception that is thrown during the invocation in a ThrowableWrapper.

Returns:Object

the result of the operation

Annotations

@Override

Exceptions

ThrowableWrapper:: if an error occurred while invoking the operation

public Class JCacheAspectSupport

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class JCacheAspectSupport.CacheOperationInvokerAdapter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail