org.springframework.integration.handler

Class AbstractReplyProducingMessageHandler

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.MessageHandlerSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.handler.AbstractMessageProducingHandler

org.springframework.integration.handler.AbstractReplyProducingMessageHandler

All Implemented Interfaces:

org.reactivestreams.Subscriber<Message<?>>, Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Ordered, ExpressionCapable, Orderable, MessageProducer, HeaderPropagationAware, IntegrationPattern, NamedComponent, IntegrationManagement, TrackableComponent, MessageHandler, reactor.core.CoreSubscriber<Message<?>>

Direct Known Subclasses:

AbstractAmqpOutboundEndpoint, AbstractHttpRequestExecutingMessageHandler, AbstractMessageSplitter, AbstractRemoteFileOutboundGateway, AbstractReplyProducingPostProcessingMessageHandler, AbstractWebServiceOutboundGateway, BarrierMessageHandler, BridgeHandler, ContentEnricher, DelayHandler, FileWritingMessageHandler, GatewayMessageHandler, JdbcOutboundGateway, JmsOutboundGateway, JpaOutboundGateway, KafkaProducerMessageHandler, MessageTransformingHandler, MongoDbOutboundGateway, OperationInvokingMessageHandler, RedisOutboundGateway, RedisQueueOutboundGateway, ReplyProducingMessageHandlerWrapper, RmiOutboundGateway, RSocketOutboundGateway, ScatterGatherHandler, ServiceActivatingHandler, StoredProcOutboundGateway, TcpOutboundGateway

public abstract class AbstractReplyProducingMessageHandler
extends AbstractMessageProducingHandler
implements BeanClassLoaderAware

Base class for MessageHandlers that are capable of producing replies.

Author:

Mark Fisher, Iwein Fuld, Oleg Zhurakousky, Gary Russell, Artem Bilan, David Liu

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractReplyProducingMessageHandler.RequestHandler An implementation of this interface is used to wrap the handleRequestMessage(Message) method.

Nested classes/interfaces inherited from interface org.springframework.integration.support.management.IntegrationManagement

IntegrationManagement.ManagementOverrides

Field Summary

Fields inherited from class org.springframework.integration.handler.AbstractMessageProducingHandler

messagingTemplate

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

EXPRESSION_PARSER, logger

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Fields inherited from interface org.springframework.integration.support.management.IntegrationManagement

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractReplyProducingMessageHandler()

Method Summary

Modifier and Type	Method and Description
protected void	doInit()
protected Object	doInvokeAdvisedRequestHandler(Message<?> message)
protected ClassLoader	getBeanClassLoader()
IntegrationPatternType	getIntegrationPatternType() Return a pattern type this component implements.
protected boolean	getRequiresReply()
protected void	handleMessageInternal(Message<?> message)
protected abstract Object	handleRequestMessage(Message<?> requestMessage) Subclasses must implement this method to handle the request Message.
protected boolean	hasAdviceChain()
protected void	onInit() Subclasses may implement this for initialization logic.
void	setAdviceChain(List<Advice> adviceChain) Configure a list of Advices to proxy a handleRequestMessage(Message) method.
void	setBeanClassLoader(ClassLoader beanClassLoader)
void	setRequiresReply(boolean requiresReply) Flag whether a reply is required.

Methods inherited from class org.springframework.integration.handler.AbstractMessageProducingHandler

addNotPropagatedHeaders, createOutputMessage, getNotPropagatedHeaders, getOutputChannel, isAsync, messageBuilderForReply, produceOutput, resolveErrorChannel, sendErrorMessage, sendOutput, sendOutputs, setAsync, setNotPropagatedHeaders, setOutputChannel, setOutputChannelName, setSendTimeout, shouldCopyRequestHeaders, shouldSplitOutput, updateNotPropagatedHeaders

Methods inherited from class org.springframework.integration.handler.AbstractMessageHandler

handleMessage, onComplete, onError, onNext, onSubscribe

Methods inherited from class org.springframework.integration.handler.MessageHandlerSupport

buildSendTimer, destroy, getComponentType, getManagedName, getManagedType, getMetricsCaptor, getOrder, getOverrides, isLoggingEnabled, registerMetricsCaptor, sendTimer, setLoggingEnabled, setManagedName, setManagedType, setOrder, setShouldTrack, shouldTrack

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

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

Methods inherited from interface reactor.core.CoreSubscriber

currentContext

Methods inherited from interface org.springframework.integration.support.management.IntegrationManagement

getThisAs

Methods inherited from interface org.springframework.integration.support.context.NamedComponent

getBeanName, getComponentName

Constructor Detail

AbstractReplyProducingMessageHandler

public AbstractReplyProducingMessageHandler()

Method Detail

setRequiresReply

public void setRequiresReply(boolean requiresReply)

Flag whether a reply is required. If true an incoming message MUST result in a reply message being sent. If false an incoming message MAY result in a reply message being sent. Default is false.

Parameters:

requiresReply - true if a reply is required.

getRequiresReply

protected boolean getRequiresReply()

setAdviceChain

public void setAdviceChain(List<Advice> adviceChain)

Configure a list of Advices to proxy a handleRequestMessage(Message) method.

Parameters:

adviceChain - the list of Advices to use.

hasAdviceChain

protected boolean hasAdviceChain()

setBeanClassLoader

public void setBeanClassLoader(ClassLoader beanClassLoader)

Specified by:

setBeanClassLoader in interface BeanClassLoaderAware

getBeanClassLoader

protected ClassLoader getBeanClassLoader()

getIntegrationPatternType

public IntegrationPatternType getIntegrationPatternType()

Description copied from interface: IntegrationPattern

Return a pattern type this component implements.

Specified by:

getIntegrationPatternType in interface IntegrationPattern

Overrides:

getIntegrationPatternType in class MessageHandlerSupport

Returns:

the IntegrationPatternType this component implements.

onInit

protected final void onInit()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class AbstractMessageProducingHandler

doInit

protected void doInit()

handleMessageInternal

protected final void handleMessageInternal(Message<?> message)

Specified by:

handleMessageInternal in class AbstractMessageHandler

doInvokeAdvisedRequestHandler

@Nullable
protected Object doInvokeAdvisedRequestHandler(Message<?> message)

handleRequestMessage

@Nullable
protected abstract Object handleRequestMessage(Message<?> requestMessage)

Subclasses must implement this method to handle the request Message. The return value may be a Message, a MessageBuilder, or any plain Object. The base class will handle the final creation of a reply Message from any of those starting points. If the return value is null, the Message flow will end here.

Parameters:

requestMessage - The request message.

Returns:

The result of handling the message, or null.