org.springframework.integration.amqp.outbound

Class AmqpOutboundEndpoint

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.handler.AbstractMessageProducingHandler

org.springframework.integration.handler.AbstractReplyProducingMessageHandler

org.springframework.integration.amqp.outbound.AmqpOutboundEndpoint

All Implemented Interfaces:

EventListener, RabbitTemplate.ConfirmCallback, RabbitTemplate.ReturnCallback, Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, InitializingBean, ApplicationContextAware, ApplicationListener<ContextRefreshedEvent>, Lifecycle, Ordered, Orderable, MessageProducer, NamedComponent, ConfigurableMetricsAware<AbstractMessageHandlerMetrics>, IntegrationManagement, IntegrationStatsManagement, MessageHandlerMetrics, TrackableComponent, MessageHandler

public class AmqpOutboundEndpoint
extends AbstractReplyProducingMessageHandler
implements RabbitTemplate.ConfirmCallback, RabbitTemplate.ReturnCallback, ApplicationListener<ContextRefreshedEvent>, Lifecycle

Adapter that converts and sends Messages to an AMQP Exchange.

Since:

2.1

Author:

Mark Fisher, Oleg Zhurakousky, Gary Russell, Artem Bilan

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.integration.handler.AbstractReplyProducingMessageHandler

AbstractReplyProducingMessageHandler.RequestHandler

Field Summary

Fields inherited from class org.springframework.integration.handler.AbstractMessageProducingHandler

messagingTemplate

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

EXPRESSION_PARSER, logger

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
AmqpOutboundEndpoint(AmqpTemplate amqpTemplate)

Method Summary

Modifier and Type	Method and Description
void	confirm(CorrelationData correlationData, boolean ack, String cause)
protected void	doInit()
String	getComponentType() Subclasses may implement this method to provide component type information.
protected Object	handleRequestMessage(Message<?> requestMessage) Subclasses must implement this method to handle the request Message.
boolean	isRunning()
protected Message	mapMessage(Message<?> requestMessage, MessageConverter converter)
void	onApplicationEvent(ContextRefreshedEvent event)
void	returnedMessage(Message message, int replyCode, String replyText, String exchange, String routingKey)
void	setConfirmAckChannel(MessageChannel ackChannel)
void	setConfirmCorrelationExpression(Expression confirmCorrelationExpression)
void	setConfirmCorrelationExpressionString(String confirmCorrelationExpression)
void	setConfirmNackChannel(MessageChannel nackChannel)
void	setDefaultDeliveryMode(MessageDeliveryMode defaultDeliveryMode)
void	setExchangeName(String exchangeName)
void	setExchangeNameExpression(Expression exchangeNameExpression)
void	setExchangeNameExpressionString(String exchangeNameExpression)
void	setExpectReply(boolean expectReply)
void	setExpressionConfirmCorrelation(Expression confirmCorrelationExpression) Deprecated. in favor of setConfirmCorrelationExpression(org.springframework.expression.Expression).
void	setExpressionExchangeName(Expression exchangeNameExpression) Deprecated. in favor of setExchangeNameExpression(org.springframework.expression.Expression).
void	setExpressionRoutingKey(Expression routingKeyExpression) Deprecated. in favor of setRoutingKeyExpression(org.springframework.expression.Expression).
void	setHeaderMapper(AmqpHeaderMapper headerMapper)
void	setLazyConnect(boolean lazyConnect) Set to false to attempt to connect during endpoint start; default true, meaning the connection will be attempted to be established on the arrival of the first message.
void	setReturnChannel(MessageChannel returnChannel)
void	setRoutingKey(String routingKey)
void	setRoutingKeyExpression(Expression routingKeyExpression)
void	setRoutingKeyExpressionString(String routingKeyExpression)
void	start()
void	stop()

Methods inherited from class org.springframework.integration.handler.AbstractReplyProducingMessageHandler

doInvokeAdvisedRequestHandler, handleMessageInternal, hasAdviceChain, onInit, setAdviceChain, setBeanClassLoader, setRequiresReply

Methods inherited from class org.springframework.integration.handler.AbstractMessageProducingHandler

getOutputChannel, produceOutput, sendOutputs, setAsyncReplySupported, setOutputChannel, setOutputChannelName, setSendTimeout, shouldCopyRequestHeaders, shouldSplitOutput

Methods inherited from class org.springframework.integration.handler.AbstractMessageHandler

configureMetrics, getActiveCount, getActiveCountLong, getDuration, getErrorCount, getErrorCountLong, getHandleCount, getHandleCountLong, getManagedName, getManagedType, getMaxDuration, getMeanDuration, getMinDuration, getOrder, getStandardDeviationDuration, handleMessage, isCountsEnabled, isLoggingEnabled, isStatsEnabled, reset, setCountsEnabled, setLoggingEnabled, setManagedName, setManagedType, setOrder, setShouldTrack, setStatsEnabled

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, 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.context.NamedComponent

getComponentName

Constructor Detail

AmqpOutboundEndpoint

public AmqpOutboundEndpoint(AmqpTemplate amqpTemplate)

Method Detail

setHeaderMapper

public void setHeaderMapper(AmqpHeaderMapper headerMapper)

setExchangeName

public void setExchangeName(String exchangeName)

setExchangeNameExpression

public void setExchangeNameExpression(Expression exchangeNameExpression)

Parameters:

exchangeNameExpression - the expression to use.

Since:

4.3

setExchangeNameExpressionString

public void setExchangeNameExpressionString(String exchangeNameExpression)

Parameters:

exchangeNameExpression - the String in SpEL syntax.

Since:

4.3

setExpressionExchangeName

@Deprecated
public void setExpressionExchangeName(Expression exchangeNameExpression)

Deprecated. in favor of setExchangeNameExpression(org.springframework.expression.Expression).

Parameters:

exchangeNameExpression - the expression to set.

setRoutingKey

public void setRoutingKey(String routingKey)

setRoutingKeyExpression

public void setRoutingKeyExpression(Expression routingKeyExpression)

Parameters:

routingKeyExpression - the expression to use.

Since:

4.3

setRoutingKeyExpressionString

public void setRoutingKeyExpressionString(String routingKeyExpression)

Parameters:

routingKeyExpression - the String in SpEL syntax.

Since:

4.3

setExpressionRoutingKey

@Deprecated
public void setExpressionRoutingKey(Expression routingKeyExpression)

Deprecated. in favor of setRoutingKeyExpression(org.springframework.expression.Expression).

Parameters:

routingKeyExpression - the expression to set.

setExpectReply

public void setExpectReply(boolean expectReply)

setConfirmCorrelationExpression

public void setConfirmCorrelationExpression(Expression confirmCorrelationExpression)

Parameters:

confirmCorrelationExpression - the expression to use.

Since:

4.3

setConfirmCorrelationExpressionString

public void setConfirmCorrelationExpressionString(String confirmCorrelationExpression)

Parameters:

confirmCorrelationExpression - the String in SpEL syntax.

Since:

4.3

setExpressionConfirmCorrelation

@Deprecated
public void setExpressionConfirmCorrelation(Expression confirmCorrelationExpression)

Deprecated. in favor of setConfirmCorrelationExpression(org.springframework.expression.Expression).

Parameters:

confirmCorrelationExpression - the expression to set.

setConfirmAckChannel

public void setConfirmAckChannel(MessageChannel ackChannel)

setConfirmNackChannel

public void setConfirmNackChannel(MessageChannel nackChannel)

setReturnChannel

public void setReturnChannel(MessageChannel returnChannel)

setDefaultDeliveryMode

public void setDefaultDeliveryMode(MessageDeliveryMode defaultDeliveryMode)

setLazyConnect

public void setLazyConnect(boolean lazyConnect)

Set to false to attempt to connect during endpoint start; default true, meaning the connection will be attempted to be established on the arrival of the first message.

Parameters:

lazyConnect - the lazyConnect to set

Since:

4.1

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 AbstractMessageHandler

doInit

protected void doInit()

Overrides:

doInit in class AbstractReplyProducingMessageHandler

onApplicationEvent

public void onApplicationEvent(ContextRefreshedEvent event)

Specified by:

onApplicationEvent in interface ApplicationListener<ContextRefreshedEvent>

start

public void start()

Specified by:

start in interface Lifecycle

stop

public void stop()

Specified by:

stop in interface Lifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface Lifecycle

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.

mapMessage

protected Message mapMessage(Message<?> requestMessage,
                             MessageConverter converter)

confirm

public void confirm(CorrelationData correlationData,
                    boolean ack,
                    String cause)

Specified by:

confirm in interface RabbitTemplate.ConfirmCallback

returnedMessage

public void returnedMessage(Message message,
                            int replyCode,
                            String replyText,
                            String exchange,
                            String routingKey)

Specified by:

returnedMessage in interface RabbitTemplate.ReturnCallback