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<org.springframework.messaging.Message<?>>
,org.springframework.amqp.rabbit.core.RabbitTemplate.ConfirmCallback
,org.springframework.amqp.rabbit.core.RabbitTemplate.ReturnCallback
,org.springframework.amqp.rabbit.core.RabbitTemplate.ReturnsCallback
,org.springframework.beans.factory.Aware
,org.springframework.beans.factory.BeanClassLoaderAware
,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.core.Ordered
,org.springframework.integration.context.ExpressionCapable
,org.springframework.integration.context.Orderable
,org.springframework.integration.core.MessageProducer
,org.springframework.integration.handler.HeaderPropagationAware
,org.springframework.integration.IntegrationPattern
,org.springframework.integration.support.context.NamedComponent
,org.springframework.integration.support.management.IntegrationManagement
,org.springframework.integration.support.management.ManageableLifecycle
,org.springframework.integration.support.management.TrackableComponent
,org.springframework.messaging.MessageHandler
,reactor.core.CoreSubscriber<org.springframework.messaging.Message<?>>
public class AmqpOutboundEndpoint extends AbstractAmqpOutboundEndpoint implements org.springframework.amqp.rabbit.core.RabbitTemplate.ConfirmCallback, org.springframework.amqp.rabbit.core.RabbitTemplate.ReturnsCallback
Adapter that converts and sends Messages to an AMQP Exchange.
- Since:
- 2.1
-
Nested Class Summary
Nested classes/interfaces inherited from class org.springframework.integration.amqp.outbound.AbstractAmqpOutboundEndpoint
AbstractAmqpOutboundEndpoint.CorrelationDataWrapper
-
Field Summary
Fields inherited from class org.springframework.integration.handler.AbstractMessageProducingHandler
messagingTemplate
Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport
EXPRESSION_PARSER, logger
-
Constructor Summary
Constructors Constructor Description AmqpOutboundEndpoint(org.springframework.amqp.core.AmqpTemplate amqpTemplate)
-
Method Summary
Modifier and Type Method Description void
confirm(org.springframework.amqp.rabbit.connection.CorrelationData correlationData, boolean ack, java.lang.String cause)
protected void
doStop()
protected void
endpointInit()
Subclasses can override to perform any additional initialization.java.lang.String
getComponentType()
org.springframework.integration.IntegrationPatternType
getIntegrationPatternType()
org.springframework.amqp.rabbit.core.RabbitTemplate
getRabbitTemplate()
protected java.lang.Object
handleRequestMessage(org.springframework.messaging.Message<?> requestMessage)
void
returnedMessage(org.springframework.amqp.core.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 anIterable
ofMessage
, 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 org.springframework.integration.amqp.outbound.AbstractAmqpOutboundEndpoint
addDelayProperty, buildReply, buildReturnedMessage, 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 org.springframework.integration.handler.AbstractReplyProducingMessageHandler
doInvokeAdvisedRequestHandler, getBeanClassLoader, getRequiresReply, handleMessageInternal, hasAdviceChain, onInit, setAdviceChain, setBeanClassLoader, setRequiresReply
Methods inherited from class org.springframework.integration.handler.AbstractMessageProducingHandler
addNotPropagatedHeaders, createOutputMessage, getNotPropagatedHeaders, getOutputChannel, isAsync, messageBuilderForReply, produceOutput, resolveErrorChannel, sendErrorMessage, sendOutput, sendOutputs, setAsync, setNotPropagatedHeaders, setOutputChannel, setOutputChannelName, setSendTimeout, shouldCopyRequestHeaders, shouldSplitOutput, updateNotPropagatedHeaders
Methods inherited from class org.springframework.integration.handler.AbstractMessageHandler
handleMessage, onComplete, onError, onNext, onSubscribe
Methods inherited from class org.springframework.integration.handler.MessageHandlerSupport
buildSendTimer, destroy, getManagedName, getManagedType, getMetricsCaptor, getOrder, getOverrides, isLoggingEnabled, registerMetricsCaptor, sendTimer, setLoggingEnabled, setManagedName, setManagedType, setOrder, setShouldTrack, shouldTrack
Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport
afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, 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.management.IntegrationManagement
getThisAs
-
Constructor Details
-
AmqpOutboundEndpoint
public AmqpOutboundEndpoint(org.springframework.amqp.core.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.- Parameters:
waitForConfirm
- true to block until the confirmation or timeout is received.- Since:
- 5.2
- See Also:
AbstractAmqpOutboundEndpoint.setConfirmTimeout(long)
,setMultiSend(boolean)
-
getComponentType
public java.lang.String getComponentType()- Specified by:
getComponentType
in interfaceorg.springframework.integration.support.context.NamedComponent
- Overrides:
getComponentType
in classorg.springframework.integration.handler.MessageHandlerSupport
-
setMultiSend
public void setMultiSend(boolean multiSend)If true, and the message payload is anIterable
ofMessage
, 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 org.springframework.integration.IntegrationPatternType getIntegrationPatternType()- Specified by:
getIntegrationPatternType
in interfaceorg.springframework.integration.IntegrationPattern
- Overrides:
getIntegrationPatternType
in classorg.springframework.integration.handler.AbstractReplyProducingMessageHandler
-
getRabbitTemplate
public org.springframework.amqp.rabbit.core.RabbitTemplate getRabbitTemplate()- Specified by:
getRabbitTemplate
in classAbstractAmqpOutboundEndpoint
-
endpointInit
protected void endpointInit()Description copied from class:AbstractAmqpOutboundEndpoint
Subclasses can override to perform any additional initialization. Called from afterPropertiesSet().- Overrides:
endpointInit
in classAbstractAmqpOutboundEndpoint
-
doStop
protected void doStop()- Overrides:
doStop
in classAbstractAmqpOutboundEndpoint
-
handleRequestMessage
protected java.lang.Object handleRequestMessage(org.springframework.messaging.Message<?> requestMessage)- Specified by:
handleRequestMessage
in classorg.springframework.integration.handler.AbstractReplyProducingMessageHandler
-
confirm
public void confirm(org.springframework.amqp.rabbit.connection.CorrelationData correlationData, boolean ack, java.lang.String cause)- Specified by:
confirm
in interfaceorg.springframework.amqp.rabbit.core.RabbitTemplate.ConfirmCallback
-
returnedMessage
public void returnedMessage(org.springframework.amqp.core.ReturnedMessage returnedMessage)- Specified by:
returnedMessage
in interfaceorg.springframework.amqp.rabbit.core.RabbitTemplate.ReturnCallback
- Specified by:
returnedMessage
in interfaceorg.springframework.amqp.rabbit.core.RabbitTemplate.ReturnsCallback
-