Class GatewayMessageHandler

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

org.springframework.integration.gateway.GatewayMessageHandler

All Implemented Interfaces:

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

public class GatewayMessageHandler
extends AbstractReplyProducingMessageHandler
implements ManageableLifecycle

The AbstractReplyProducingMessageHandler implementation for mid-flow Gateway.

Since:

5.0

Author:

Artem Bilan, Christian Tzolov

Nested Class Summary

Nested classes/interfaces inherited from class AbstractReplyProducingMessageHandler

AbstractReplyProducingMessageHandler.RequestHandler

Nested classes/interfaces inherited from interface IntegrationManagement

IntegrationManagement.ManagementOverrides

Field Summary

Fields inherited from class AbstractMessageProducingHandler

messagingTemplate

Fields inherited from class IntegrationObjectSupport

EXPRESSION_PARSER, logger

Fields inherited from interface IntegrationManagement

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Fields inherited from interface Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
GatewayMessageHandler()

Method Summary

Modifier and Type	Method	Description
protected Object	handleRequestMessage(Message<?> requestMessage)	Subclasses must implement this method to handle the request Message.
boolean	isRunning()
void	setAsyncExecutor(@Nullable Executor executor)	Set the executor for use when the gateway method returns Future or CompletableFuture.
void	setErrorChannel(MessageChannel errorChannel)
void	setErrorChannelName(String errorChannel)
void	setErrorOnTimeout(boolean errorOnTimeout)
void	setReplyChannel(MessageChannel replyChannel)
void	setReplyChannelName(String replyChannel)
void	setReplyTimeout(Long replyTimeout)
void	setRequestChannel(MessageChannel requestChannel)
void	setRequestChannelName(String requestChannel)
void	setRequestTimeout(Long requestTimeout)
void	start()
void	stop()

Methods inherited from class AbstractReplyProducingMessageHandler

doInit, doInvokeAdvisedRequestHandler, getBeanClassLoader, getIntegrationPatternType, getRequiresReply, handleMessageInternal, hasAdviceChain, onInit, setAdviceChain, setBeanClassLoader, setRequiresReply

Methods inherited from class 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 AbstractMessageHandler

handleMessage, onComplete, onError, onNext, onSubscribe, setObservationConvention

Methods inherited from class 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 IntegrationObjectSupport

afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentDescription, getComponentName, getComponentSource, getConversionService, getExpression, getIntegrationProperties, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentDescription, setComponentName, setComponentSource, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

Methods inherited from class Object

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

Methods inherited from interface reactor.core.CoreSubscriber

currentContext

Methods inherited from interface IntegrationManagement

getThisAs

Methods inherited from interface NamedComponent

getBeanName, getComponentName

Constructor Details

GatewayMessageHandler

public GatewayMessageHandler()

Method Details

setRequestChannel

public void setRequestChannel(MessageChannel requestChannel)

setRequestChannelName

public void setRequestChannelName(String requestChannel)

setReplyChannel

public void setReplyChannel(MessageChannel replyChannel)

setReplyChannelName

public void setReplyChannelName(String replyChannel)

setErrorChannel

public void setErrorChannel(MessageChannel errorChannel)

setErrorChannelName

public void setErrorChannelName(String errorChannel)

setRequestTimeout

public void setRequestTimeout(Long requestTimeout)

setReplyTimeout

public void setReplyTimeout(Long replyTimeout)

setErrorOnTimeout

public void setErrorOnTimeout(boolean errorOnTimeout)

setAsyncExecutor

public void setAsyncExecutor(@Nullable Executor executor)

Set the executor for use when the gateway method returns Future or CompletableFuture. Set it to null to disable the async processing, and any Future return types must be returned by the downstream flow.

Parameters:

executor - The executor.

handleRequestMessage

protected Object handleRequestMessage(Message<?> requestMessage)

Description copied from class: AbstractReplyProducingMessageHandler

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.

Specified by:

handleRequestMessage in class AbstractReplyProducingMessageHandler

Parameters:

requestMessage - The request message.

Returns:

The result of handling the message, or null.

start

public void start()

Specified by:

start in interface Lifecycle

Specified by:

start in interface ManageableLifecycle

stop

public void stop()

Specified by:

stop in interface Lifecycle

Specified by:

stop in interface ManageableLifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface Lifecycle

Specified by:

isRunning in interface ManageableLifecycle