MessagingGatewaySupport (Spring Integration 5.1.0.M2 API)

java.lang.Object
- org.springframework.integration.context.IntegrationObjectSupport
- - org.springframework.integration.endpoint.AbstractEndpoint
  - - org.springframework.integration.gateway.MessagingGatewaySupport

All Implemented Interfaces:

org.springframework.beans.factory.Aware, 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.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle, ExpressionCapable, NamedComponent, IntegrationManagement, MessageSourceMetrics, TrackableComponent

Direct Known Subclasses:

AbstractWebServiceInboundGateway, AmqpInboundGateway, BaseHttpInboundEndpoint, JmsInboundGateway, RedisQueueInboundGateway, RmiInboundGateway, TcpInboundGateway
```
@IntegrationManagedResource
public abstract class MessagingGatewaySupport
extends AbstractEndpoint
implements TrackableComponent, MessageSourceMetrics
```
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

Fields
Modifier and Type	Field and Description
`protected MessagingTemplate`	`messagingTemplate`

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected org.springframework.messaging.support.ErrorMessage`	`buildErrorMessage(org.springframework.messaging.Message<?> requestMessage, java.lang.Throwable throwable)` Build an error message for the message and throwable using the configured `ErrorMessageStrategy`.
`protected void`	`doStart()` Subclasses must implement this method with the start behavior.
`protected void`	`doStop()` Subclasses must implement this method with the stop behavior.
`java.lang.String`	`getComponentType()` Subclasses may implement this method to provide component type information.
`org.springframework.messaging.MessageChannel`	`getErrorChannel()` Return the error channel (if provided) to which error messages will be routed.
`protected org.springframework.core.AttributeAccessor`	`getErrorMessageAttributes(org.springframework.messaging.Message<?> message)` Populate an `AttributeAccessor` to be used when building an error message with the `errorMessageStrategy`.
`java.lang.String`	`getManagedName()`
`java.lang.String`	`getManagedType()`
`int`	`getMessageCount()`
`long`	`getMessageCountLong()`
`IntegrationManagement.ManagementOverrides`	`getOverrides()` Return the overrides.
`org.springframework.messaging.MessageChannel`	`getReplyChannel()` Return this gateway's reply channel if any.
`org.springframework.messaging.MessageChannel`	`getRequestChannel()` Return this gateway's request channel.
`boolean`	`isCountsEnabled()`
`boolean`	`isLoggingEnabled()`
`protected void`	`onInit()` Subclasses may implement this for initialization logic.
`protected java.lang.Object`	`receive()`
`protected java.lang.Object`	`receive(long timeout)`
`protected org.springframework.messaging.Message<?>`	`receiveMessage()`
`protected org.springframework.messaging.Message<?>`	`receiveMessage(long timeout)`
`protected void`	`registerReplyMessageCorrelatorIfNecessary()`
`void`	`reset()`
`protected void`	`send(java.lang.Object object)`
`protected java.lang.Object`	`sendAndReceive(java.lang.Object object)`
`protected org.springframework.messaging.Message<?>`	`sendAndReceiveMessage(java.lang.Object object)`
`protected reactor.core.publisher.Mono<org.springframework.messaging.Message<?>>`	`sendAndReceiveMessageReactive(java.lang.Object object)`
`void`	`setCountsEnabled(boolean countsEnabled)`
`void`	`setErrorChannel(org.springframework.messaging.MessageChannel errorChannel)` Set the error channel.
`void`	`setErrorChannelName(java.lang.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`	`setLoggingEnabled(boolean enabled)`
`void`	`setManagedName(java.lang.String name)`
`void`	`setManagedType(java.lang.String type)`
`void`	`setReplyChannel(org.springframework.messaging.MessageChannel replyChannel)` Set the reply channel.
`void`	`setReplyChannelName(java.lang.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(org.springframework.messaging.MessageChannel requestChannel)` Set the request channel.
`void`	`setRequestChannelName(java.lang.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
destroy, doStop, getPhase, getRole, isAutoStartup, isRunning, setAutoStartup, setPhase, setRole, setTaskScheduler, start, stop, stop

Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport
afterPropertiesSet, extractTypeIfPossible, getApplicationContext, getApplicationContextId, getBeanFactory, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, 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.context.NamedComponent
getComponentName

Methods inherited from interface org.springframework.integration.support.management.MessageSourceMetrics
setCounter

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

- 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
- Method Detail
  - setRequestChannel
```
public void setRequestChannel(org.springframework.messaging.MessageChannel requestChannel)
```
    Set the request channel.
    
    Parameters:
    
    requestChannel - the channel to which request messages will be sent
  - setRequestChannelName
```
public void setRequestChannelName(java.lang.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(org.springframework.messaging.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(java.lang.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(org.springframework.messaging.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(java.lang.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(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
  - getMessageCount
```
public int getMessageCount()
```
    Specified by:
    
    getMessageCount in interface MessageSourceMetrics
    
    Returns:
    
    the number of successful handler calls
  - getMessageCountLong
```
public long getMessageCountLong()
```
    Specified by:
    
    getMessageCountLong in interface MessageSourceMetrics
    
    Returns:
    
    the number of successful handler calls
  - setManagedName
```
public void setManagedName(java.lang.String name)
```
    Specified by:
    
    setManagedName in interface MessageSourceMetrics
  - getManagedName
```
public java.lang.String getManagedName()
```
    Specified by:
    
    getManagedName in interface MessageSourceMetrics
  - setManagedType
```
public void setManagedType(java.lang.String type)
```
    Specified by:
    
    setManagedType in interface MessageSourceMetrics
  - getManagedType
```
public java.lang.String getManagedType()
```
    Specified by:
    
    getManagedType in interface MessageSourceMetrics
  - getComponentType
```
public java.lang.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)
```
    Specified by:
    
    setLoggingEnabled in interface IntegrationManagement
  - isLoggingEnabled
```
public boolean isLoggingEnabled()
```
    Specified by:
    
    isLoggingEnabled in interface IntegrationManagement
  - setCountsEnabled
```
public void setCountsEnabled(boolean countsEnabled)
```
    Specified by:
    
    setCountsEnabled in interface IntegrationManagement
  - isCountsEnabled
```
public boolean isCountsEnabled()
```
    Specified by:
    
    isCountsEnabled in interface IntegrationManagement
  - 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.
  - onInit
```
protected void onInit()
               throws java.lang.Exception
```
    Description copied from class: IntegrationObjectSupport
    
    Subclasses may implement this for initialization logic.
    
    Overrides:
    
    onInit in class AbstractEndpoint
    
    Throws:
    
    java.lang.Exception - Any exception.
  - getRequestChannel
```
public org.springframework.messaging.MessageChannel getRequestChannel()
```
    Return this gateway's request channel.
    
    Returns:
    
    the channel.
    
    Since:
    
    4.2
  - getReplyChannel
```
public org.springframework.messaging.MessageChannel getReplyChannel()
```
    Return this gateway's reply channel if any.
    
    Returns:
    
    the reply channel instance
    
    Since:
    
    5.1
  - getErrorChannel
```
public org.springframework.messaging.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(java.lang.Object object)
```
  - receive
```
protected java.lang.Object receive()
```
  - receiveMessage
```
protected org.springframework.messaging.Message<?> receiveMessage()
```
  - receive
```
protected java.lang.Object receive(long timeout)
```
  - receiveMessage
```
protected org.springframework.messaging.Message<?> receiveMessage(long timeout)
```
  - sendAndReceive
```
protected java.lang.Object sendAndReceive(java.lang.Object object)
```
  - sendAndReceiveMessage
```
protected org.springframework.messaging.Message<?> sendAndReceiveMessage(java.lang.Object object)
```
  - sendAndReceiveMessageReactive
```
protected reactor.core.publisher.Mono<org.springframework.messaging.Message<?>> sendAndReceiveMessageReactive(java.lang.Object object)
```
  - buildErrorMessage
```
protected final org.springframework.messaging.support.ErrorMessage buildErrorMessage(org.springframework.messaging.Message<?> requestMessage,
                                                                                     java.lang.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 org.springframework.core.AttributeAccessor getErrorMessageAttributes(org.springframework.messaging.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
  - reset
```
public void reset()
```
    Specified by:
    
    reset in interface IntegrationManagement

Class MessagingGatewaySupport

Nested Class Summary

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

Field Summary

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

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

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

Fields inherited from interface org.springframework.context.SmartLifecycle

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

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

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

Field Detail

messagingTemplate

Constructor Detail

MessagingGatewaySupport

MessagingGatewaySupport

Method Detail

setRequestChannel

setRequestChannelName

setReplyChannel

setReplyChannelName

setErrorChannel

setErrorChannelName

setRequestTimeout

setReplyTimeout

setRequestMapper

setReplyMapper

setShouldTrack

getMessageCount

getMessageCountLong

setManagedName

getManagedName

setManagedType

getManagedType

getComponentType

setLoggingEnabled

isLoggingEnabled

setCountsEnabled

isCountsEnabled

setErrorMessageStrategy

getOverrides

onInit

getRequestChannel

getReplyChannel

getErrorChannel

send

receive

receiveMessage

receive

receiveMessage

sendAndReceive

sendAndReceiveMessage

sendAndReceiveMessageReactive

buildErrorMessage

getErrorMessageAttributes

registerReplyMessageCorrelatorIfNecessary

doStart

doStop

reset