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
,CamelMessageHandler
,CassandraMessageHandler
,ContentEnricher
,DelayHandler
,FileWritingMessageHandler
,GatewayMessageHandler
,GraphQlMessageHandler
,JdbcOutboundGateway
,JmsOutboundGateway
,JpaOutboundGateway
,KafkaProducerMessageHandler
,MessageTransformingHandler
,MongoDbOutboundGateway
,OperationInvokingMessageHandler
,RedisOutboundGateway
,RedisQueueOutboundGateway
,ReplyProducingMessageHandlerWrapper
,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, Trung Pham
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
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
Fields inherited from interface org.springframework.core.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected void
doInit()
protected Object
doInvokeAdvisedRequestHandler
(Message<?> message) protected ClassLoader
Return a pattern type this component implements.protected boolean
protected final void
handleMessageInternal
(Message<?> message) protected abstract Object
handleRequestMessage
(Message<?> requestMessage) Subclasses must implement this method to handle the request Message.protected boolean
protected final void
onInit()
Subclasses may implement this for initialization logic.void
setAdviceChain
(List<Advice> adviceChain) Configure a list ofAdvice
s to proxy ahandleRequestMessage(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, setupMessageProcessor, shouldCopyRequestHeaders, shouldSplitOutput, updateNotPropagatedHeaders
Methods inherited from class org.springframework.integration.handler.AbstractMessageHandler
handleMessage, onComplete, onError, onNext, onSubscribe, setObservationConvention
Methods inherited from class org.springframework.integration.handler.MessageHandlerSupport
buildSendTimer, destroy, getComponentType, getManagedName, getManagedType, getMetricsCaptor, getObservationRegistry, getOrder, getOverrides, isLoggingEnabled, isObserved, registerMetricsCaptor, registerObservationRegistry, 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 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
Configure a list ofAdvice
s to proxy ahandleRequestMessage(Message)
method.- Parameters:
adviceChain
- the list ofAdvice
s to use.
-
hasAdviceChain
protected boolean hasAdviceChain() -
setBeanClassLoader
- Specified by:
setBeanClassLoader
in interfaceBeanClassLoaderAware
-
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
- Specified by:
handleMessageInternal
in classAbstractMessageHandler
-
doInvokeAdvisedRequestHandler
-
handleRequestMessage
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
.
-