Class AmqpOutboundEndpoint

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.MessageHandlerSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.handler.AbstractMessageProducingHandler

org.springframework.integration.handler.AbstractReplyProducingMessageHandler

org.springframework.integration.amqp.outbound.AbstractAmqpOutboundEndpoint

org.springframework.integration.amqp.outbound.AmqpOutboundEndpoint

All Implemented Interfaces:

org.reactivestreams.Subscriber<Message<?>>, RabbitTemplate.ConfirmCallback, RabbitTemplate.ReturnsCallback, Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Lifecycle, Ordered, ComponentSourceAware, ExpressionCapable, Orderable, MessageProducer, HeaderPropagationAware, IntegrationPattern, NamedComponent, IntegrationManagement, ManageableLifecycle, TrackableComponent, MessageHandler, reactor.core.CoreSubscriber<Message<?>>

public class AmqpOutboundEndpoint
extends AbstractAmqpOutboundEndpoint
implements RabbitTemplate.ConfirmCallback, RabbitTemplate.ReturnsCallback

Adapter that converts and sends Messages to an AMQP Exchange.

Since:

2.1

Author:

Mark Fisher, Oleg Zhurakousky, Gary Russell, Artem Bilan, Ngoc Nhan, Jun Cho

Nested Class Summary

Nested classes/interfaces inherited from class AbstractAmqpOutboundEndpoint

AbstractAmqpOutboundEndpoint.CorrelationDataWrapper

Nested classes/interfaces inherited from class AbstractReplyProducingMessageHandler

AbstractReplyProducingMessageHandler.RequestHandler

Nested classes/interfaces inherited from interface IntegrationManagement

IntegrationManagement.ManagementOverrides

Field Summary

Fields inherited from class AbstractMessageProducingHandler

messagingTemplate

Fields inherited from class IntegrationObjectSupport

EXPRESSION_PARSER, logger

Fields inherited from interface IntegrationManagement

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Fields inherited from interface Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
AmqpOutboundEndpoint(AmqpTemplate amqpTemplate)

Method Summary

Modifier and Type	Method	Description
void	confirm(@Nullable CorrelationData correlationData, boolean ack, @Nullable String cause)
protected void	doStop()
protected void	endpointInit()	Subclasses can override to perform any additional initialization.
String	getComponentType()
IntegrationPatternType	getIntegrationPatternType()	Return a pattern type this component implements.
@Nullable RabbitTemplate	getRabbitTemplate()
protected @Nullable Object	handleRequestMessage(Message<?> requestMessage)	Subclasses must implement this method to handle the request Message.
void	returnedMessage(ReturnedMessage returnedMessage)
void	setExpectReply(boolean expectReply)	Set to true if this endpoint is a gateway.
void	setMultiSend(boolean multiSend)	If true, and the message payload is an Iterable of Message, send the messages in a single invocation of the template (same channel) and optionally wait for the confirms or die or perform all sends within a transaction (existing or new).
void	setWaitForConfirm(boolean waitForConfirm)	Set to true if you want to block the calling thread until a publisher confirm has been received.

Methods inherited from class AbstractAmqpOutboundEndpoint

addDelayProperty, buildReply, buildReturnedMessage, doInit, doStart, generateCorrelationData, generateExchangeName, generateRoutingKey, getConfirmAckChannel, getConfirmCorrelationExpression, getConfirmNackChannel, getConfirmTimeout, getCorrelationDataGenerator, getDefaultDeliveryMode, getExchangeName, getExchangeNameExpression, getExchangeNameGenerator, getHeaderMapper, getReturnChannel, getRoutingKey, getRoutingKeyExpression, getRoutingKeyGenerator, handleConfirm, isHeadersMappedLast, isLazyConnect, isRunning, setConfirmAckChannel, setConfirmAckChannelName, setConfirmCorrelationExpression, setConfirmCorrelationExpressionString, setConfirmNackChannel, setConfirmNackChannelName, setConfirmTimeout, setConnectionFactory, setDefaultDeliveryMode, setDelay, setDelayExpression, setDelayExpressionString, setErrorMessageStrategy, setExchangeName, setExchangeNameExpression, setExchangeNameExpressionString, setHeaderMapper, setHeadersMappedLast, setLazyConnect, setReturnChannel, setRoutingKey, setRoutingKeyExpression, setRoutingKeyExpressionString, start, stop

Methods inherited from class AbstractReplyProducingMessageHandler

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

Methods inherited from class AbstractMessageProducingHandler

addNotPropagatedHeaders, createOutputMessage, getNotPropagatedHeaders, getOutputChannel, isAsync, messageBuilderForReply, produceOutput, resolveErrorChannel, sendErrorMessage, sendOutput, sendOutputs, setAsync, setNotPropagatedHeaders, setOutputChannel, setOutputChannelName, setSendTimeout, setupMessageProcessor, shouldCopyRequestHeaders, shouldSplitOutput, updateNotPropagatedHeaders

Methods inherited from class AbstractMessageHandler

handleMessage, onComplete, onError, onNext, onSubscribe, setObservationConvention

Methods inherited from class MessageHandlerSupport

buildSendTimer, destroy, getManagedName, getManagedType, getMetricsCaptor, getObservationRegistry, getOrder, getOverrides, isLoggingEnabled, isObserved, registerMetricsCaptor, registerObservationRegistry, sendTimer, setLoggingEnabled, setManagedName, setManagedType, setOrder, setShouldTrack, shouldTrack

Methods inherited from class IntegrationObjectSupport

afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentDescription, getComponentName, getComponentSource, getConversionService, getExpression, getIntegrationProperties, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentDescription, setComponentName, setComponentSource, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface reactor.core.CoreSubscriber

currentContext

Methods inherited from interface IntegrationManagement

getThisAs

Methods inherited from interface NamedComponent

getBeanName, getComponentName

Constructor Details

AmqpOutboundEndpoint

public AmqpOutboundEndpoint(AmqpTemplate amqpTemplate)

Method Details

setExpectReply

public void setExpectReply(boolean expectReply)

Set to true if this endpoint is a gateway.

Parameters:

expectReply - true for a gateway.

setWaitForConfirm

public void setWaitForConfirm(boolean waitForConfirm)

Set to true if you want to block the calling thread until a publisher confirm has been received. Requires a template configured for returns. If a confirm is not received within the confirm timeout or a negative acknowledgment or returned message is received, an exception will be thrown. Does not apply to the gateway since it blocks awaiting the reply.

When there is no correlation data for the message and the connection factory is configured for simple publisher confirms, the message is sent within the scope of a RabbitTemplate.invoke() operation and waitForConfirmsOrDie() is used instead. A returned message does not fail the send in that case; it is published to the return channel, if one is configured.

Parameters:

waitForConfirm - true to block until the confirmation or timeout is received.

Since:

5.2

See Also:

• AbstractAmqpOutboundEndpoint.setConfirmTimeout(long)
• setMultiSend(boolean)

getComponentType

public String getComponentType()

Specified by:

getComponentType in interface NamedComponent

Overrides:

getComponentType in class MessageHandlerSupport

setMultiSend

public void setMultiSend(boolean multiSend)

If true, and the message payload is an Iterable of Message, send the messages in a single invocation of the template (same channel) and optionally wait for the confirms or die or perform all sends within a transaction (existing or new).

Parameters:

multiSend - true to send multiple messages.

Since:

5.3

See Also:

• setWaitForConfirm(boolean)

getIntegrationPatternType

public IntegrationPatternType getIntegrationPatternType()

Description copied from interface: IntegrationPattern

Return a pattern type this component implements.

Specified by:

getIntegrationPatternType in interface IntegrationPattern

Overrides:

getIntegrationPatternType in class AbstractReplyProducingMessageHandler

Returns:

the IntegrationPatternType this component implements.

getRabbitTemplate

public @Nullable RabbitTemplate getRabbitTemplate()

Specified by:

getRabbitTemplate in class AbstractAmqpOutboundEndpoint

endpointInit

protected void endpointInit()

Description copied from class: AbstractAmqpOutboundEndpoint

Subclasses can override to perform any additional initialization. Called from afterPropertiesSet().

Overrides:

endpointInit in class AbstractAmqpOutboundEndpoint

doStop

protected void doStop()

Overrides:

doStop in class AbstractAmqpOutboundEndpoint

handleRequestMessage

protected @Nullable 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.

confirm

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

Specified by:

confirm in interface RabbitTemplate.ConfirmCallback

returnedMessage

public void returnedMessage(ReturnedMessage returnedMessage)

Specified by:

returnedMessage in interface RabbitTemplate.ReturnsCallback