Package org.springframework.integration.handler.advice

Class CacheRequestHandlerAdvice

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.advice.AbstractRequestHandlerAdvice

org.springframework.integration.handler.advice.CacheRequestHandlerAdvice

All Implemented Interfaces:

Advice, Interceptor, MethodInterceptor, Aware, BeanFactoryAware, BeanNameAware, InitializingBean, SmartInitializingSingleton, ApplicationContextAware, ComponentSourceAware, ExpressionCapable, NamedComponent

public class CacheRequestHandlerAdvice
extends AbstractRequestHandlerAdvice
implements SmartInitializingSingleton

The AbstractRequestHandlerAdvice implementation for caching AbstractReplyProducingMessageHandler.RequestHandler#handleRequestMessage(Message) results. Supports all the cache operations - cacheable, put, evict. By default, only cacheable is applied for the provided cacheNames. The default cache key is payload of the request message.

Since:

5.2

Author:

Artem Bilan, Ngoc Nhan

See Also:

• CacheAspectSupport
• CacheOperation

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.integration.handler.advice.AbstractRequestHandlerAdvice

AbstractRequestHandlerAdvice.ExecutionCallback, AbstractRequestHandlerAdvice.ThrowableHolderException

Field Summary

Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport

EXPRESSION_PARSER, logger

Constructor Summary

Constructors

Constructor	Description
CacheRequestHandlerAdvice(String... cacheNamesArg)	Create a CacheRequestHandlerAdvice instance based on the provided name of caches and CacheableOperation as default one.

Method Summary

Modifier and Type	Method	Description
void	afterSingletonsInstantiated()
protected Object	doInvoke(AbstractRequestHandlerAdvice.ExecutionCallback callback, Object target, Message<?> message)	Subclasses implement this method to apply behavior to the MessageHandler.
protected void	onInit()	Subclasses may implement this for initialization logic.
void	setCacheManager(CacheManager cacheManager)	Configure a common CacheManager if some CacheOperation comes without it.
void	setCacheOperations(CacheOperation... cacheOperations)	Configure a set of CacheOperation which are going to be applied to the AbstractReplyProducingMessageHandler.RequestHandler#handleRequestMessage(Message) method via CacheRequestHandlerAdvice.IntegrationCacheAspect.
void	setCacheResolver(CacheResolver cacheResolver)	Configure a common CacheResolver if some CacheOperation comes without it.
void	setErrorHandler(CacheErrorHandler errorHandler)	Set the CacheErrorHandler instance to use to handle errors thrown by the cache provider.
void	setKeyExpression(Expression keyExpression)	Configure a SpEL expression to evaluate a cache key at runtime against a request message.
void	setKeyExpressionString(String keyExpression)	Configure an expression in SpEL style to evaluate a cache key at runtime against a request message.
void	setKeyFunction(Function<Message<?>,?> keyFunction)	Configure a Function to evaluate a cache key at runtime against a request message.

Methods inherited from class org.springframework.integration.handler.advice.AbstractRequestHandlerAdvice

invoke, unwrapExceptionIfNecessary, unwrapThrowableIfNecessary

Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport

afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentDescription, getComponentName, getComponentSource, getComponentType, getConversionService, getExpression, getIntegrationProperties, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentDescription, setComponentName, setComponentSource, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

Methods inherited from class java.lang.Object

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

Constructor Details

CacheRequestHandlerAdvice

public CacheRequestHandlerAdvice(String... cacheNamesArg)

Create a CacheRequestHandlerAdvice instance based on the provided name of caches and CacheableOperation as default one. This can be overridden by the setCacheOperations(org.springframework.cache.interceptor.CacheOperation...).

Parameters:

cacheNamesArg - the name of caches to use in the advice.

See Also:

• setCacheOperations(org.springframework.cache.interceptor.CacheOperation...)

Method Details

setCacheOperations

public void setCacheOperations(CacheOperation... cacheOperations)

Configure a set of CacheOperation which are going to be applied to the AbstractReplyProducingMessageHandler.RequestHandler#handleRequestMessage(Message) method via CacheRequestHandlerAdvice.IntegrationCacheAspect. This is similar to the technique provided by the Caching annotation.

Parameters:

cacheOperations - the array of CacheOperation to use.

See Also:

• Caching

setCacheManager

public void setCacheManager(CacheManager cacheManager)

Configure a common CacheManager if some CacheOperation comes without it. See CacheConfig annotation for similar approach.

Parameters:

cacheManager - the CacheManager to use.

See Also:

• CacheConfig

setCacheResolver

public void setCacheResolver(CacheResolver cacheResolver)

Configure a common CacheResolver if some CacheOperation comes without it. See CacheConfig for similar approach.

Parameters:

cacheResolver - the CacheResolver to use.

See Also:

• CacheConfig

setErrorHandler

public void setErrorHandler(CacheErrorHandler errorHandler)

Set the CacheErrorHandler instance to use to handle errors thrown by the cache provider.

Parameters:

errorHandler - the CacheErrorHandler to use.

See Also:

• AbstractCacheInvoker.setErrorHandler(CacheErrorHandler)

setKeyExpressionString

public void setKeyExpressionString(String keyExpression)

Configure an expression in SpEL style to evaluate a cache key at runtime against a request message.

Parameters:

keyExpression - the expression to use for cache key generation.

setKeyFunction

public void setKeyFunction(Function<Message<?>,?> keyFunction)

Configure a Function to evaluate a cache key at runtime against a request message.

Parameters:

keyFunction - the Function to use for cache key generation.

setKeyExpression

public void setKeyExpression(Expression keyExpression)

Configure a SpEL expression to evaluate a cache key at runtime against a request message.

Parameters:

keyExpression - the expression to use for cache key generation.

afterSingletonsInstantiated

public void afterSingletonsInstantiated()

Specified by:

afterSingletonsInstantiated in interface SmartInitializingSingleton

onInit

protected void onInit()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class IntegrationObjectSupport

doInvoke

@Nullable
protected Object doInvoke(AbstractRequestHandlerAdvice.ExecutionCallback callback,
 Object target,
 Message<?> message)

Description copied from class: AbstractRequestHandlerAdvice

Subclasses implement this method to apply behavior to the MessageHandler.

callback.execute() invokes the handler method and returns its result, or null.

Specified by:

doInvoke in class AbstractRequestHandlerAdvice

Parameters:

callback - Subclasses invoke the execute() method on this interface to invoke the handler method.

target - The target handler.

message - The message that will be sent to the handler.

Returns:

the result after invoking the MessageHandler.