MessagingGatewaySupport (Spring Integration 4.2.5.RELEASE API)

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

All Implemented Interfaces:

Aware, BeanFactoryAware, BeanNameAware, InitializingBean, ApplicationContextAware, Lifecycle, Phased, SmartLifecycle, NamedComponent, IntegrationManagement, MessageSourceMetrics, TrackableComponent

Direct Known Subclasses:

AbstractWebServiceInboundGateway, AmqpInboundGateway, HttpRequestHandlingEndpointSupport, 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

Field Summary
- Fields inherited from class org.springframework.integration.endpoint.AbstractEndpoint
  lifecycleCondition, lifecycleLock
- Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport
  logger

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 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.
`protected MessageChannel`	`getErrorChannel()`
`String`	`getManagedName()`
`String`	`getManagedType()`
`int`	`getMessageCount()`
`long`	`getMessageCountLong()`
`protected MessageChannel`	`getReplyChannel()`
`MessageChannel`	`getRequestChannel()`
`boolean`	`isCountsEnabled()`
`boolean`	`isLoggingEnabled()`
`protected void`	`onInit()` Subclasses may implement this for initialization logic.
`protected Object`	`receive()`
`void`	`reset()`
`protected void`	`send(Object object)`
`protected Object`	`sendAndReceive(Object object)`
`protected Message<?>`	`sendAndReceiveMessage(Object object)`
`void`	`setCountsEnabled(boolean countsEnabled)`
`void`	`setErrorChannel(MessageChannel errorChannel)` Set the error channel.
`void`	`setErrorChannelName(String errorChannelName)` Set the error channel name.
`void`	`setLoggingEnabled(boolean enabled)`
`void`	`setManagedName(String name)`
`void`	`setManagedType(String type)`
`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, isAutoStartup, isRunning, setAutoStartup, setPhase, setTaskScheduler, start, stop, stop

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

- 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(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(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(String name)
```
    Specified by:
    
    setManagedName in interface MessageSourceMetrics
  - getManagedName
```
public String getManagedName()
```
    Specified by:
    
    getManagedName in interface MessageSourceMetrics
  - setManagedType
```
public void setManagedType(String type)
```
    Specified by:
    
    setManagedType in interface MessageSourceMetrics
  - getManagedType
```
public String getManagedType()
```
    Specified by:
    
    getManagedType in interface MessageSourceMetrics
  - 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)
```
    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
  - onInit
```
protected void onInit()
               throws Exception
```
    Description copied from class: IntegrationObjectSupport
    
    Subclasses may implement this for initialization logic.
    
    Overrides:
    
    onInit in class IntegrationObjectSupport
    
    Throws:
    
    Exception - Any exception.
  - getRequestChannel
```
public MessageChannel getRequestChannel()
```
  - getReplyChannel
```
protected MessageChannel getReplyChannel()
```
  - getErrorChannel
```
protected MessageChannel getErrorChannel()
```
  - send
```
protected void send(Object object)
```
  - receive
```
protected Object receive()
```
  - sendAndReceive
```
protected Object sendAndReceive(Object object)
```
  - sendAndReceiveMessage
```
protected Message<?> sendAndReceiveMessage(Object object)
```
  - 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

Field Summary

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

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

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

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

onInit

getRequestChannel

getReplyChannel

getErrorChannel

send

receive

sendAndReceive

sendAndReceiveMessage

doStart

doStop

reset