Package org.springframework.integration.handler.advice

Class ContextHolderRequestHandlerAdvice

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.advice.AbstractRequestHandlerAdvice

org.springframework.integration.handler.advice.ContextHolderRequestHandlerAdvice

All Implemented Interfaces:

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

public class ContextHolderRequestHandlerAdvice
extends AbstractRequestHandlerAdvice

An AbstractRequestHandlerAdvice implementation to store and reset a value into/from some context (e.g. ThreadLocal) against a request message. The context is populated before callback.execute() and reset after.

Since:

6.1

Author:

Adel Haidar, Artem Bilan

Nested Class Summary

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

AbstractRequestHandlerAdvice.ExecutionCallback, AbstractRequestHandlerAdvice.ThrowableHolderException

Field Summary

Fields

Modifier and Type	Field	Description
final Runnable	contextClearHook
final Consumer<Object>	contextSetHook
final Function<Message<?>,Object>	valueProvider

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

EXPRESSION_PARSER, logger

Constructor Summary

Constructors

Constructor	Description
ContextHolderRequestHandlerAdvice(Function<Message<?>,Object> valueProvider, Consumer<Object> contextSetHook, Runnable contextClearHook)	Construct an instance based on the provided hooks.

Method Summary

Modifier and Type	Method	Description
protected Object	doInvoke(AbstractRequestHandlerAdvice.ExecutionCallback callback, Object target, Message<?> message)	Subclasses implement this method to apply behavior to the MessageHandler.

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, getComponentName, getComponentType, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, onInit, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

Methods inherited from class java.lang.Object

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

Field Details

valueProvider

public final Function<Message<?>,Object> valueProvider

contextSetHook

public final Consumer<Object> contextSetHook

contextClearHook

public final Runnable contextClearHook

Constructor Details

ContextHolderRequestHandlerAdvice

public ContextHolderRequestHandlerAdvice(Function<Message<?>,Object> valueProvider,
 Consumer<Object> contextSetHook,
 Runnable contextClearHook)

Construct an instance based on the provided hooks.

Parameters:

valueProvider - The key provider function.

contextSetHook - The context set hook consumer.

contextClearHook - The context clear hook consumer.

Method Details

doInvoke

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.