org.springframework.integration.gateway

Class MessagingGatewaySupport

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.endpoint.AbstractEndpoint

org.springframework.integration.gateway.MessagingGatewaySupport

All Implemented Interfaces:

Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Lifecycle, Phased, SmartLifecycle, ExpressionCapable, IntegrationPattern, NamedComponent, IntegrationInboundManagement, IntegrationManagement, ManageableLifecycle, ManageableSmartLifecycle, TrackableComponent

Direct Known Subclasses:

AbstractWebServiceInboundGateway, AmqpInboundGateway, BaseHttpInboundEndpoint, JmsInboundGateway, KafkaInboundGateway, RedisQueueInboundGateway, RmiInboundGateway, RSocketInboundGateway, TcpInboundGateway

@IntegrationManagedResource
public abstract class MessagingGatewaySupport
extends AbstractEndpoint
implements TrackableComponent, IntegrationInboundManagement, IntegrationPattern

A convenient base class for connecting application code to MessageChannels for sending, receiving, or request-reply operations. Exposes setters for configuring request and reply MessageChannels as well as the timeout values for sending and receiving Messages.

Author:

Mark Fisher, Gary Russell, Artem Bilan

Nested Class Summary

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

IntegrationManagement.ManagementOverrides

Field Summary

Fields

Modifier and Type	Field and Description
protected MessagingTemplate	messagingTemplate

Fields inherited from class org.springframework.integration.endpoint.AbstractEndpoint

lifecycleCondition, lifecycleLock

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.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor and Description
MessagingGatewaySupport() Construct an instance that will return null if no reply is received.
MessagingGatewaySupport(boolean errorOnTimeout) If errorOnTimeout is true, construct an instance that will send an ErrorMessage with a MessageTimeoutException payload to the error channel if a reply is expected but none is received.

Method Summary

Modifier and Type	Method and Description
protected ErrorMessage	buildErrorMessage(Message<?> requestMessage, Throwable throwable) Build an error message for the message and throwable using the configured ErrorMessageStrategy.
protected TimerFacade	buildSendTimer(boolean success, String exception)
void	destroy()
protected void	doStart() Subclasses must implement this method with the start behavior.
protected void	doStop() Subclasses must implement this method with the stop behavior.
String	getComponentType() Subclasses may implement this method to provide component type information.
MessageChannel	getErrorChannel() Return the error channel (if provided) to which error messages will be routed.
protected AttributeAccessor	getErrorMessageAttributes(Message<?> message) Populate an AttributeAccessor to be used when building an error message with the errorMessageStrategy.
IntegrationPatternType	getIntegrationPatternType() Return a pattern type this component implements.
String	getManagedName()
String	getManagedType()
IntegrationManagement.ManagementOverrides	getOverrides() Return the overrides.
MessageChannel	getReplyChannel() Return this gateway's reply channel if any.
MessageChannel	getRequestChannel() Return this gateway's request channel.
boolean	isLoggingEnabled() Return whether logging is enabled.
protected void	onInit() Subclasses may implement this for initialization logic.
protected Object	receive()
protected Object	receive(long timeout)
protected Message<?>	receiveMessage()
protected Message<?>	receiveMessage(long timeout)
void	registerMetricsCaptor(MetricsCaptor metricsCaptorToRegister) Inject a MetricsCaptor
protected void	registerReplyMessageCorrelatorIfNecessary()
protected void	send(Object object)
protected Object	sendAndReceive(Object object)
protected Message<?>	sendAndReceiveMessage(Object object)
protected reactor.core.publisher.Mono<Message<?>>	sendAndReceiveMessageReactive(Object object)
protected TimerFacade	sendTimer()
void	setErrorChannel(MessageChannel errorChannel) Set the error channel.
void	setErrorChannelName(String errorChannelName) Set the error channel name.
void	setErrorMessageStrategy(ErrorMessageStrategy errorMessageStrategy) Set an ErrorMessageStrategy to use to build an error message when a exception occurs.
void	setErrorOnTimeout(boolean errorOnTimeout) If errorOnTimeout is true, construct an instance that will send an ErrorMessage with a MessageTimeoutException payload to the error channel if a reply is expected but none is received.
void	setLoggingEnabled(boolean enabled) Enable logging or not.
void	setManagedName(String managedName)
void	setManagedType(String managedType)
void	setReplyChannel(MessageChannel replyChannel) Set the reply channel.
void	setReplyChannelName(String replyChannelName) Set the reply channel name.
void	setReplyMapper(OutboundMessageMapper<?> replyMapper) Provide an OutboundMessageMapper for mapping to objects from any reply Messages received in receive or sendAndReceive operations.
void	setReplyTimeout(long replyTimeout) Set the timeout value for receiving reply messages.
void	setRequestChannel(MessageChannel requestChannel) Set the request channel.
void	setRequestChannelName(String requestChannelName) Set the request channel name.
void	setRequestMapper(InboundMessageMapper<?> requestMapper) Provide an InboundMessageMapper for creating request Messages from any object passed in a send or sendAndReceive operation.
void	setRequestTimeout(long requestTimeout) Set the timeout value for sending request messages.
void	setShouldTrack(boolean shouldTrack) Specify whether this gateway should be tracked in the Message History of Messages that originate from its send or sendAndReceive operations.

Methods inherited from class org.springframework.integration.endpoint.AbstractEndpoint

doStop, getPhase, getRole, isAutoStartup, isRunning, setAutoStartup, setPhase, setRole, start, stop, stop

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

Field Detail

messagingTemplate

protected final MessagingTemplate messagingTemplate

Constructor Detail

MessagingGatewaySupport

public MessagingGatewaySupport()

Construct an instance that will return null if no reply is received.

MessagingGatewaySupport

public MessagingGatewaySupport(boolean errorOnTimeout)

If errorOnTimeout is true, construct an instance that will send an ErrorMessage with a MessageTimeoutException payload to the error channel if a reply is expected but none is received. If no error channel is configured, the MessageTimeoutException will be thrown.

Parameters:

errorOnTimeout - true to create the error message.

Since:

4.2

See Also:

setErrorOnTimeout(boolean)

Method Detail

setErrorOnTimeout

public void setErrorOnTimeout(boolean errorOnTimeout)

If errorOnTimeout is true, construct an instance that will send an ErrorMessage with a MessageTimeoutException payload to the error channel if a reply is expected but none is received. If no error channel is configured, the MessageTimeoutException will be thrown.

Parameters:

errorOnTimeout - true to create the error message on reply timeout.

Since:

5.2.2

setRequestChannel

public void setRequestChannel(MessageChannel requestChannel)

Set the request channel.

Parameters:

requestChannel - the channel to which request messages will be sent

setRequestChannelName

public void setRequestChannelName(String requestChannelName)

Set the request channel name.

Parameters:

requestChannelName - the channel bean name to which request messages will be sent

Since:

4.1

setReplyChannel

public void setReplyChannel(MessageChannel replyChannel)

Set the reply channel. If no reply channel is provided, this gateway will always use an anonymous, temporary channel for handling replies.

Parameters:

replyChannel - the channel from which reply messages will be received

setReplyChannelName

public void setReplyChannelName(String replyChannelName)

Set the reply channel name. If no reply channel is provided, this gateway will always use an anonymous, temporary channel for handling replies.

Parameters:

replyChannelName - the channel bean name from which reply messages will be received

Since:

4.1

setErrorChannel

public void setErrorChannel(MessageChannel errorChannel)

Set the error channel. If no error channel is provided, this gateway will propagate Exceptions to the caller. To completely suppress Exceptions, provide a reference to the "nullChannel" here.

Parameters:

errorChannel - The error channel.

setErrorChannelName

public void setErrorChannelName(String errorChannelName)

Set the error channel name. If no error channel is provided, this gateway will propagate Exceptions to the caller. To completely suppress Exceptions, provide a reference to the "nullChannel" here.

Parameters:

errorChannelName - The error channel bean name.

Since:

4.1

setRequestTimeout

public void setRequestTimeout(long requestTimeout)

Set the timeout value for sending request messages. If not explicitly configured, the default is one second.

Parameters:

requestTimeout - the timeout value in milliseconds

setReplyTimeout

public void setReplyTimeout(long replyTimeout)

Set the timeout value for receiving reply messages. If not explicitly configured, the default is one second.

Parameters:

replyTimeout - the timeout value in milliseconds

setRequestMapper

public void setRequestMapper(@Nullable
                             InboundMessageMapper<?> requestMapper)

Provide an InboundMessageMapper for creating request Messages from any object passed in a send or sendAndReceive operation.

Parameters:

requestMapper - The request mapper.

setReplyMapper

public void setReplyMapper(OutboundMessageMapper<?> replyMapper)

Provide an OutboundMessageMapper for mapping to objects from any reply Messages received in receive or sendAndReceive operations.

Parameters:

replyMapper - The reply mapper.

setShouldTrack

public void setShouldTrack(boolean shouldTrack)

Specify whether this gateway should be tracked in the Message History of Messages that originate from its send or sendAndReceive operations.

Specified by:

setShouldTrack in interface TrackableComponent

getComponentType

public String getComponentType()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this method to provide component type information.

Specified by:

getComponentType in interface NamedComponent

Overrides:

getComponentType in class IntegrationObjectSupport

setLoggingEnabled

public void setLoggingEnabled(boolean enabled)

Description copied from interface: IntegrationManagement

Enable logging or not.

Specified by:

setLoggingEnabled in interface IntegrationManagement

Parameters:

enabled - dalse to disable.

isLoggingEnabled

public boolean isLoggingEnabled()

Description copied from interface: IntegrationManagement

Return whether logging is enabled.

Specified by:

isLoggingEnabled in interface IntegrationManagement

Returns:

true if enabled.

setErrorMessageStrategy

public final void setErrorMessageStrategy(ErrorMessageStrategy errorMessageStrategy)

Set an ErrorMessageStrategy to use to build an error message when a exception occurs. Default is the DefaultErrorMessageStrategy.

Parameters:

errorMessageStrategy - the ErrorMessageStrategy.

Since:

4.3.10

getOverrides

public IntegrationManagement.ManagementOverrides getOverrides()

Description copied from interface: IntegrationManagement

Return the overrides.

Specified by:

getOverrides in interface IntegrationManagement

Returns:

the overrides.

setManagedType

public void setManagedType(String managedType)

Specified by:

setManagedType in interface IntegrationManagement

getManagedType

public String getManagedType()

Specified by:

getManagedType in interface IntegrationManagement

setManagedName

public void setManagedName(String managedName)

Specified by:

setManagedName in interface IntegrationManagement

getManagedName

public String getManagedName()

Specified by:

getManagedName in interface IntegrationManagement

getIntegrationPatternType

public IntegrationPatternType getIntegrationPatternType()

Description copied from interface: IntegrationPattern

Return a pattern type this component implements.

Specified by:

getIntegrationPatternType in interface IntegrationPattern

Returns:

the IntegrationPatternType this component implements.

registerMetricsCaptor

public void registerMetricsCaptor(MetricsCaptor metricsCaptorToRegister)

Description copied from interface: IntegrationManagement

Inject a MetricsCaptor

Specified by:

registerMetricsCaptor in interface IntegrationManagement

Parameters:

metricsCaptorToRegister - the captor.

onInit

protected void onInit()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class AbstractEndpoint

getRequestChannel

@Nullable
public MessageChannel getRequestChannel()

Return this gateway's request channel.

Returns:

the channel.

Since:

4.2

getReplyChannel

@Nullable
public MessageChannel getReplyChannel()

Return this gateway's reply channel if any.

Returns:

the reply channel instance

Since:

5.1

getErrorChannel

@Nullable
public MessageChannel getErrorChannel()

Return the error channel (if provided) to which error messages will be routed.

Returns:

the channel or null.

Since:

4.3

send

protected void send(Object object)

receive

@Nullable
protected Object receive()

receiveMessage

@Nullable
protected Message<?> receiveMessage()

receive

@Nullable
protected Object receive(long timeout)

receiveMessage

@Nullable
protected Message<?> receiveMessage(long timeout)

sendAndReceive

@Nullable
protected Object sendAndReceive(Object object)

sendAndReceiveMessage

@Nullable
protected Message<?> sendAndReceiveMessage(Object object)

sendAndReceiveMessageReactive

protected reactor.core.publisher.Mono<Message<?>> sendAndReceiveMessageReactive(Object object)

sendTimer

protected TimerFacade sendTimer()

buildSendTimer

protected TimerFacade buildSendTimer(boolean success,
                                     String exception)

buildErrorMessage

protected final ErrorMessage buildErrorMessage(@Nullable
                                               Message<?> requestMessage,
                                               Throwable throwable)

Build an error message for the message and throwable using the configured ErrorMessageStrategy.

Parameters:

requestMessage - the requestMessage.

throwable - the throwable.

Returns:

the error message.

Since:

4.3.10

getErrorMessageAttributes

protected AttributeAccessor getErrorMessageAttributes(@Nullable
                                                      Message<?> message)

Populate an AttributeAccessor to be used when building an error message with the errorMessageStrategy.

Parameters:

message - the message.

Returns:

the attributes.

Since:

4.3.10

registerReplyMessageCorrelatorIfNecessary

protected void registerReplyMessageCorrelatorIfNecessary()

doStart

protected void doStart()

Description copied from class: AbstractEndpoint

Subclasses must implement this method with the start behavior. This method will be invoked while holding the AbstractEndpoint.lifecycleLock.

Specified by:

doStart in class AbstractEndpoint

doStop

protected void doStop()

Description copied from class: AbstractEndpoint

Subclasses must implement this method with the stop behavior. This method will be invoked while holding the AbstractEndpoint.lifecycleLock.

Specified by:

doStop in class AbstractEndpoint

destroy

public void destroy()

Specified by:

destroy in interface DisposableBean

Specified by:

destroy in interface IntegrationManagement

Overrides:

destroy in class AbstractEndpoint