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, InitializingBean, ApplicationContextAware, Lifecycle, Phased, SmartLifecycle, TrackableComponent, NamedComponent

Direct Known Subclasses:

AbstractWebServiceInboundGateway, AmqpInboundGateway, HttpRequestHandlingEndpointSupport, RedisQueueInboundGateway, RmiInboundGateway, TcpInboundGateway

public abstract class MessagingGatewaySupport
extends AbstractEndpoint
implements TrackableComponent

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()

Method Summary

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()
protected MessageChannel	getReplyChannel()
protected MessageChannel	getRequestChannel()
protected void	onInit() Subclasses may implement this for initialization logic.
protected Object	receive()
protected void	send(Object object)
protected Object	sendAndReceive(Object object)
protected Message<?>	sendAndReceiveMessage(Object object)
void	setErrorChannel(MessageChannel errorChannel) Set the error channel.
void	setErrorChannelName(String errorChannelName) Set the error channel name.
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()

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

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

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

protected 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