Class AbstractRequestHandlerAdvice

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.advice.AbstractRequestHandlerAdvice

All Implemented Interfaces:

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

Direct Known Subclasses:

CacheRequestHandlerAdvice, ContextHolderRequestHandlerAdvice, ExpressionEvaluatingRequestHandlerAdvice, LockRequestHandlerAdvice, RateLimiterRequestHandlerAdvice, RequestHandlerCircuitBreakerAdvice, RequestHandlerRetryAdvice

public abstract class AbstractRequestHandlerAdvice
extends IntegrationObjectSupport
implements MethodInterceptor

Base class for MessageHandler advice classes. Subclasses should provide an implementation for doInvoke(ExecutionCallback, Object, Message). Used to advise the handleRequestMessage method for AbstractReplyProducingMessageHandler or MessageHandler.handleMessage(Message) for other message handlers.

Since:

2.2

Author:

Gary Russell, Artem Bilan, Ngoc Nhan

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	AbstractRequestHandlerAdvice.ExecutionCallback	Called by subclasses in doInvoke(org.springframework.integration.handler.advice.AbstractRequestHandlerAdvice.ExecutionCallback, java.lang.Object, org.springframework.messaging.Message<?>) to proceed() the invocation.
protected static final class	AbstractRequestHandlerAdvice.ThrowableHolderException

Field Summary

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

EXPRESSION_PARSER, logger

Constructor Summary

Constructors

Constructor	Description
AbstractRequestHandlerAdvice()

Method Summary

Modifier and Type	Method	Description
protected abstract @Nullable Object	doInvoke(AbstractRequestHandlerAdvice.ExecutionCallback callback, Object target, Message<?> message)	Subclasses implement this method to apply behavior to the MessageHandler.
String	getComponentType()
final @Nullable Object	invoke(MethodInvocation invocation)
protected Exception	unwrapExceptionIfNecessary(Exception exception)	Unwrap the cause of a AbstractRequestHandlerAdvice.ThrowableHolderException.
protected Throwable	unwrapThrowableIfNecessary(Exception e)	Unwrap the cause of a AbstractRequestHandlerAdvice.ThrowableHolderException.

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

afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentDescription, getComponentName, getComponentSource, getConversionService, getExpression, getIntegrationProperties, getMessageBuilderFactory, getTaskScheduler, isInitialized, onInit, 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

AbstractRequestHandlerAdvice

public AbstractRequestHandlerAdvice()

Method Details

invoke

public final @Nullable Object invoke(MethodInvocation invocation)
                              throws Throwable

Specified by:

invoke in interface MethodInterceptor

Throws:

Throwable

getComponentType

public String getComponentType()

Specified by:

getComponentType in interface NamedComponent

doInvoke

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

Subclasses implement this method to apply behavior to the MessageHandler.

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

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.

unwrapExceptionIfNecessary

protected Exception unwrapExceptionIfNecessary(Exception exception)

Unwrap the cause of a AbstractRequestHandlerAdvice.ThrowableHolderException.

Parameters:

exception - The exception.

Returns:

The cause, or exception, if not a AbstractRequestHandlerAdvice.ThrowableHolderException

unwrapThrowableIfNecessary

protected Throwable unwrapThrowableIfNecessary(Exception e)

Unwrap the cause of a AbstractRequestHandlerAdvice.ThrowableHolderException.

Parameters:

e - The exception.

Returns:

The cause, or e, if not a AbstractRequestHandlerAdvice.ThrowableHolderException