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<org.springframework.messaging.Message<?>>
,org.springframework.beans.factory.Aware
,org.springframework.beans.factory.BeanClassLoaderAware
,org.springframework.beans.factory.BeanFactoryAware
,org.springframework.beans.factory.BeanNameAware
,org.springframework.beans.factory.DisposableBean
,org.springframework.beans.factory.InitializingBean
,org.springframework.context.ApplicationContextAware
,org.springframework.core.Ordered
,ExpressionCapable
,Orderable
,MessageProducer
,HeaderPropagationAware
,IntegrationPattern
,NamedComponent
,IntegrationManagement
,TrackableComponent
,org.springframework.messaging.MessageHandler
,reactor.core.CoreSubscriber<org.springframework.messaging.Message<?>>
- Direct Known Subclasses:
AbstractMessageSplitter
,AbstractReplyProducingPostProcessingMessageHandler
,BarrierMessageHandler
,BridgeHandler
,ContentEnricher
,DelayHandler
,GatewayMessageHandler
,MessageTransformingHandler
,ReplyProducingMessageHandlerWrapper
,ScatterGatherHandler
,ServiceActivatingHandler
public abstract class AbstractReplyProducingMessageHandler extends AbstractMessageProducingHandler implements org.springframework.beans.factory.BeanClassLoaderAware
Base class for MessageHandlers that are capable of producing replies.
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
AbstractReplyProducingMessageHandler.RequestHandler
An implementation of this interface is used to wrap thehandleRequestMessage(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.integration.support.management.IntegrationManagement
METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME
-
Constructor Summary
Constructors Constructor Description AbstractReplyProducingMessageHandler()
-
Method Summary
Modifier and Type Method Description protected void
doInit()
protected java.lang.Object
doInvokeAdvisedRequestHandler(org.springframework.messaging.Message<?> message)
protected java.lang.ClassLoader
getBeanClassLoader()
IntegrationPatternType
getIntegrationPatternType()
Return a pattern type this component implements.protected boolean
getRequiresReply()
protected void
handleMessageInternal(org.springframework.messaging.Message<?> message)
protected abstract java.lang.Object
handleRequestMessage(org.springframework.messaging.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(java.util.List<org.aopalliance.aop.Advice> adviceChain)
Configure a list ofAdvice
s to proxy ahandleRequestMessage(Message)
method.void
setBeanClassLoader(java.lang.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 org.springframework.integration.support.management.IntegrationManagement
getThisAs
Methods inherited from interface org.springframework.integration.support.context.NamedComponent
getBeanName, getComponentName
-
Constructor Details
-
AbstractReplyProducingMessageHandler
public AbstractReplyProducingMessageHandler()
-
-
Method Details
-
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(java.util.List<org.aopalliance.aop.Advice> adviceChain)Configure a list ofAdvice
s to proxy ahandleRequestMessage(Message)
method.- Parameters:
adviceChain
- the list ofAdvice
s to use.
-
hasAdviceChain
protected boolean hasAdviceChain() -
setBeanClassLoader
public void setBeanClassLoader(java.lang.ClassLoader beanClassLoader)- Specified by:
setBeanClassLoader
in interfaceorg.springframework.beans.factory.BeanClassLoaderAware
-
getBeanClassLoader
protected java.lang.ClassLoader getBeanClassLoader() -
getIntegrationPatternType
Description copied from interface:IntegrationPattern
Return a pattern type this component implements.- Specified by:
getIntegrationPatternType
in interfaceIntegrationPattern
- Overrides:
getIntegrationPatternType
in classMessageHandlerSupport
- 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 classAbstractMessageProducingHandler
-
doInit
protected void doInit() -
handleMessageInternal
protected final void handleMessageInternal(org.springframework.messaging.Message<?> message)- Specified by:
handleMessageInternal
in classAbstractMessageHandler
-
doInvokeAdvisedRequestHandler
@Nullable protected java.lang.Object doInvokeAdvisedRequestHandler(org.springframework.messaging.Message<?> message) -
handleRequestMessage
@Nullable protected abstract java.lang.Object handleRequestMessage(org.springframework.messaging.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
.
-