Class AbstractAmqpOutboundEndpoint
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
- All Implemented Interfaces:
org.reactivestreams.Subscriber<org.springframework.messaging.Message<?>>,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<?>>
- Direct Known Subclasses:
AmqpOutboundEndpoint,AsyncAmqpOutboundGateway
public abstract class AbstractAmqpOutboundEndpoint
extends org.springframework.integration.handler.AbstractReplyProducingMessageHandler
implements org.springframework.integration.support.management.ManageableLifecycle
- Since:
- 4.3
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static classAbstractAmqpOutboundEndpoint.CorrelationDataWrapper -
Field Summary
Fields inherited from class org.springframework.integration.handler.AbstractMessageProducingHandler
messagingTemplateFields inherited from class org.springframework.integration.context.IntegrationObjectSupport
EXPRESSION_PARSER, logger -
Constructor Summary
Constructors Constructor Description AbstractAmqpOutboundEndpoint() -
Method Summary
Modifier and Type Method Description protected voidaddDelayProperty(org.springframework.messaging.Message<?> message, org.springframework.amqp.core.Message amqpMessage)protected org.springframework.integration.support.AbstractIntegrationMessageBuilder<?>buildReply(org.springframework.amqp.support.converter.MessageConverter converter, org.springframework.amqp.core.Message amqpReplyMessage)protected org.springframework.messaging.Message<?>buildReturnedMessage(org.springframework.amqp.core.Message message, int replyCode, java.lang.String replyText, java.lang.String exchange, java.lang.String returnedRoutingKey, org.springframework.amqp.support.converter.MessageConverter converter)Deprecated.since 5.4 in favor ofbuildReturnedMessage(ReturnedMessage, MessageConverter)protected org.springframework.messaging.Message<?>buildReturnedMessage(org.springframework.amqp.core.ReturnedMessage returnedMessage, org.springframework.amqp.support.converter.MessageConverter converter)protected voiddoInit()protected voiddoStart()protected voiddoStop()protected voidendpointInit()Subclasses can override to perform any additional initialization.protected org.springframework.amqp.rabbit.connection.CorrelationDatagenerateCorrelationData(org.springframework.messaging.Message<?> requestMessage)protected java.lang.StringgenerateExchangeName(org.springframework.messaging.Message<?> requestMessage)protected java.lang.StringgenerateRoutingKey(org.springframework.messaging.Message<?> requestMessage)protected org.springframework.messaging.MessageChannelgetConfirmAckChannel()protected org.springframework.expression.ExpressiongetConfirmCorrelationExpression()protected org.springframework.messaging.MessageChannelgetConfirmNackChannel()protected java.time.DurationgetConfirmTimeout()protected org.springframework.integration.handler.ExpressionEvaluatingMessageProcessor<java.lang.Object>getCorrelationDataGenerator()protected org.springframework.amqp.core.MessageDeliveryModegetDefaultDeliveryMode()protected java.lang.StringgetExchangeName()protected org.springframework.expression.ExpressiongetExchangeNameExpression()protected org.springframework.integration.handler.ExpressionEvaluatingMessageProcessor<java.lang.String>getExchangeNameGenerator()AmqpHeaderMappergetHeaderMapper()protected abstract org.springframework.amqp.rabbit.core.RabbitTemplategetRabbitTemplate()protected org.springframework.messaging.MessageChannelgetReturnChannel()protected java.lang.StringgetRoutingKey()protected org.springframework.expression.ExpressiongetRoutingKeyExpression()protected org.springframework.integration.handler.ExpressionEvaluatingMessageProcessor<java.lang.String>getRoutingKeyGenerator()protected voidhandleConfirm(org.springframework.amqp.rabbit.connection.CorrelationData correlationData, boolean ack, java.lang.String cause)protected booleanisHeadersMappedLast()protected booleanisLazyConnect()booleanisRunning()voidsetConfirmAckChannel(org.springframework.messaging.MessageChannel ackChannel)Set the channel to which acks are send (publisher confirms).voidsetConfirmAckChannelName(java.lang.String ackChannelName)Set the channel name to which acks are send (publisher confirms).voidsetConfirmCorrelationExpression(org.springframework.expression.Expression confirmCorrelationExpression)Set a SpEL expression to evaluate confirm correlation at runtime.voidsetConfirmCorrelationExpressionString(java.lang.String confirmCorrelationExpression)Set a SpEL expression to evaluate confirm correlation at runtime.voidsetConfirmNackChannel(org.springframework.messaging.MessageChannel nackChannel)Set the channel to which nacks are send (publisher confirms).voidsetConfirmNackChannelName(java.lang.String nackChannelName)Set the channel name to which nacks are send (publisher confirms).voidsetConfirmTimeout(long confirmTimeout)Set a timeout after which a nack will be synthesized if no publisher confirm has been received within that time.protected voidsetConnectionFactory(org.springframework.amqp.rabbit.connection.ConnectionFactory connectionFactory)voidsetDefaultDeliveryMode(org.springframework.amqp.core.MessageDeliveryMode defaultDeliveryMode)Set the default delivery mode.voidsetDelay(int delay)Set the value to set in thex-delayheader when using the RabbitMQ delayed message exchange plugin.voidsetDelayExpression(org.springframework.expression.Expression delayExpression)Set the SpEL expression to calculate thex-delayheader when using the RabbitMQ delayed message exchange plugin.voidsetDelayExpressionString(java.lang.String delayExpression)Set the SpEL expression to calculate thex-delayheader when using the RabbitMQ delayed message exchange plugin.voidsetErrorMessageStrategy(org.springframework.integration.support.ErrorMessageStrategy errorMessageStrategy)Set the error message strategy to use for returned (or negatively confirmed) messages.voidsetExchangeName(java.lang.String exchangeName)Configure an AMQP exchange name for sending messages.voidsetExchangeNameExpression(org.springframework.expression.Expression exchangeNameExpression)Configure a SpEL expression to evaluate an exchange name at runtime.voidsetExchangeNameExpressionString(java.lang.String exchangeNameExpression)voidsetHeaderMapper(AmqpHeaderMapper headerMapper)Set a customAmqpHeaderMapperfor mapping request and reply headers.voidsetHeadersMappedLast(boolean headersMappedLast)When mapping headers for the outbound message, determine whether the headers are mapped before the message is converted, or afterwards.voidsetLazyConnect(boolean lazyConnect)Set tofalseto attempt to connect during endpoint start; defaulttrue, meaning the connection will be attempted to be established on the arrival of the first message.voidsetReturnChannel(org.springframework.messaging.MessageChannel returnChannel)Set the channel to which returned messages are sent.voidsetRoutingKey(java.lang.String routingKey)Configure an AMQP routing key for sending messages.voidsetRoutingKeyExpression(org.springframework.expression.Expression routingKeyExpression)voidsetRoutingKeyExpressionString(java.lang.String routingKeyExpression)voidstart()voidstop()Methods inherited from class org.springframework.integration.handler.AbstractReplyProducingMessageHandler
doInvokeAdvisedRequestHandler, getBeanClassLoader, getIntegrationPatternType, getRequiresReply, handleMessageInternal, handleRequestMessage, hasAdviceChain, onInit, setAdviceChain, setBeanClassLoader, setRequiresReplyMethods 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, updateNotPropagatedHeadersMethods inherited from class org.springframework.integration.handler.AbstractMessageHandler
handleMessage, onComplete, onError, onNext, onSubscribeMethods inherited from class org.springframework.integration.handler.MessageHandlerSupport
buildSendTimer, destroy, getComponentType, getManagedName, getManagedType, getMetricsCaptor, getOrder, getOverrides, isLoggingEnabled, registerMetricsCaptor, sendTimer, setLoggingEnabled, setManagedName, setManagedType, setOrder, setShouldTrack, shouldTrackMethods 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, toStringMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Constructor Details
-
AbstractAmqpOutboundEndpoint
public AbstractAmqpOutboundEndpoint()
-
-
Method Details
-
setHeaderMapper
Set a customAmqpHeaderMapperfor mapping request and reply headers. Defaults toDefaultAmqpHeaderMapper.outboundMapper().- Parameters:
headerMapper- theAmqpHeaderMapperto use.
-
setHeadersMappedLast
public void setHeadersMappedLast(boolean headersMappedLast)When mapping headers for the outbound message, determine whether the headers are mapped before the message is converted, or afterwards. This only affects headers that might be added by the message converter. When false, the converter's headers win; when true, any headers added by the converter will be overridden (if the source message has a header that maps to those headers). You might wish to set this to true, for example, when using aSimpleMessageConverterwith a String payload that contains json; the converter will set the content type totext/plainwhich can be overridden toapplication/jsonby setting theAmqpHeaders.CONTENT_TYPEmessage header. Default: false.- Parameters:
headersMappedLast- true if headers are mapped after conversion.- Since:
- 5.0
-
setExchangeName
public void setExchangeName(java.lang.String exchangeName)Configure an AMQP exchange name for sending messages.- Parameters:
exchangeName- the exchange name for sending messages.
-
setExchangeNameExpression
public void setExchangeNameExpression(org.springframework.expression.Expression exchangeNameExpression)Configure a SpEL expression to evaluate an exchange name at runtime.- Parameters:
exchangeNameExpression- the expression to use.- Since:
- 4.3
-
setExchangeNameExpressionString
public void setExchangeNameExpressionString(java.lang.String exchangeNameExpression)- Parameters:
exchangeNameExpression- the String in SpEL syntax.- Since:
- 4.3
-
setRoutingKey
public void setRoutingKey(java.lang.String routingKey)Configure an AMQP routing key for sending messages.- Parameters:
routingKey- the routing key to use
-
setRoutingKeyExpression
public void setRoutingKeyExpression(org.springframework.expression.Expression routingKeyExpression)- Parameters:
routingKeyExpression- the expression to use.- Since:
- 4.3
-
setRoutingKeyExpressionString
public void setRoutingKeyExpressionString(java.lang.String routingKeyExpression)- Parameters:
routingKeyExpression- the String in SpEL syntax.- Since:
- 4.3
-
setConfirmCorrelationExpression
public void setConfirmCorrelationExpression(org.springframework.expression.Expression confirmCorrelationExpression)Set a SpEL expression to evaluate confirm correlation at runtime.- Parameters:
confirmCorrelationExpression- the expression to use.- Since:
- 4.3
-
setConfirmCorrelationExpressionString
public void setConfirmCorrelationExpressionString(java.lang.String confirmCorrelationExpression)Set a SpEL expression to evaluate confirm correlation at runtime.- Parameters:
confirmCorrelationExpression- the String in SpEL syntax.- Since:
- 4.3
-
setConfirmAckChannel
public void setConfirmAckChannel(org.springframework.messaging.MessageChannel ackChannel)Set the channel to which acks are send (publisher confirms).- Parameters:
ackChannel- the channel.
-
setConfirmAckChannelName
public void setConfirmAckChannelName(java.lang.String ackChannelName)Set the channel name to which acks are send (publisher confirms).- Parameters:
ackChannelName- the channel name.- Since:
- 4.3.12
-
setConfirmNackChannel
public void setConfirmNackChannel(org.springframework.messaging.MessageChannel nackChannel)Set the channel to which nacks are send (publisher confirms).- Parameters:
nackChannel- the channel.
-
setConfirmNackChannelName
public void setConfirmNackChannelName(java.lang.String nackChannelName)Set the channel name to which nacks are send (publisher confirms).- Parameters:
nackChannelName- the channel name.- Since:
- 4.3.12
-
setReturnChannel
public void setReturnChannel(org.springframework.messaging.MessageChannel returnChannel)Set the channel to which returned messages are sent.- Parameters:
returnChannel- the channel.
-
setDefaultDeliveryMode
public void setDefaultDeliveryMode(org.springframework.amqp.core.MessageDeliveryMode defaultDeliveryMode)Set the default delivery mode.- Parameters:
defaultDeliveryMode- the delivery mode.
-
setLazyConnect
public void setLazyConnect(boolean lazyConnect)Set tofalseto attempt to connect during endpoint start; defaulttrue, 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
-
setDelay
public void setDelay(int delay)Set the value to set in thex-delayheader when using the RabbitMQ delayed message exchange plugin. By default, theAmqpHeaders.DELAYheader (if present) is mapped; setting the delay here overrides that value.- Parameters:
delay- the delay.- Since:
- 4.3.5
-
setDelayExpression
public void setDelayExpression(org.springframework.expression.Expression delayExpression)Set the SpEL expression to calculate thex-delayheader when using the RabbitMQ delayed message exchange plugin. By default, theAmqpHeaders.DELAYheader (if present) is mapped; setting the expression here overrides that value.- Parameters:
delayExpression- the expression.- Since:
- 4.3.5
-
setDelayExpressionString
public void setDelayExpressionString(@Nullable java.lang.String delayExpression)Set the SpEL expression to calculate thex-delayheader when using the RabbitMQ delayed message exchange plugin. By default, theAmqpHeaders.DELAYheader (if present) is mapped; setting the expression here overrides that value.- Parameters:
delayExpression- the expression.- Since:
- 4.3.5
-
setErrorMessageStrategy
public void setErrorMessageStrategy(org.springframework.integration.support.ErrorMessageStrategy errorMessageStrategy)Set the error message strategy to use for returned (or negatively confirmed) messages.- Parameters:
errorMessageStrategy- the strategy.- Since:
- 4.3.12
-
setConfirmTimeout
public void setConfirmTimeout(long confirmTimeout)Set a timeout after which a nack will be synthesized if no publisher confirm has been received within that time. Missing confirms will be checked every 50% of this value so the synthesized nack will be sent between 1x and 1.5x this timeout.- Parameters:
confirmTimeout- the approximate timeout.- Since:
- 5.2
- See Also:
setConfirmNackChannel(MessageChannel)
-
setConnectionFactory
protected final void setConnectionFactory(org.springframework.amqp.rabbit.connection.ConnectionFactory connectionFactory) -
getExchangeName
protected java.lang.String getExchangeName() -
getRoutingKey
protected java.lang.String getRoutingKey() -
getExchangeNameExpression
protected org.springframework.expression.Expression getExchangeNameExpression() -
getRoutingKeyExpression
protected org.springframework.expression.Expression getRoutingKeyExpression() -
getRoutingKeyGenerator
protected org.springframework.integration.handler.ExpressionEvaluatingMessageProcessor<java.lang.String> getRoutingKeyGenerator() -
getExchangeNameGenerator
protected org.springframework.integration.handler.ExpressionEvaluatingMessageProcessor<java.lang.String> getExchangeNameGenerator() -
getHeaderMapper
-
getConfirmCorrelationExpression
protected org.springframework.expression.Expression getConfirmCorrelationExpression() -
getCorrelationDataGenerator
protected org.springframework.integration.handler.ExpressionEvaluatingMessageProcessor<java.lang.Object> getCorrelationDataGenerator() -
getConfirmAckChannel
protected org.springframework.messaging.MessageChannel getConfirmAckChannel() -
getConfirmNackChannel
protected org.springframework.messaging.MessageChannel getConfirmNackChannel() -
getReturnChannel
protected org.springframework.messaging.MessageChannel getReturnChannel() -
getDefaultDeliveryMode
protected org.springframework.amqp.core.MessageDeliveryMode getDefaultDeliveryMode() -
isLazyConnect
protected boolean isLazyConnect() -
isHeadersMappedLast
protected boolean isHeadersMappedLast() -
getConfirmTimeout
@Nullable protected java.time.Duration getConfirmTimeout() -
doInit
protected final void doInit()- Overrides:
doInitin classorg.springframework.integration.handler.AbstractReplyProducingMessageHandler
-
endpointInit
protected void endpointInit()Subclasses can override to perform any additional initialization. Called from afterPropertiesSet(). -
start
public void start()- Specified by:
startin interfaceorg.springframework.context.Lifecycle- Specified by:
startin interfaceorg.springframework.integration.support.management.ManageableLifecycle
-
getRabbitTemplate
@Nullable protected abstract org.springframework.amqp.rabbit.core.RabbitTemplate getRabbitTemplate() -
stop
public void stop()- Specified by:
stopin interfaceorg.springframework.context.Lifecycle- Specified by:
stopin interfaceorg.springframework.integration.support.management.ManageableLifecycle
-
doStart
protected void doStart() -
doStop
protected void doStop() -
isRunning
public boolean isRunning()- Specified by:
isRunningin interfaceorg.springframework.context.Lifecycle- Specified by:
isRunningin interfaceorg.springframework.integration.support.management.ManageableLifecycle
-
generateCorrelationData
protected org.springframework.amqp.rabbit.connection.CorrelationData generateCorrelationData(org.springframework.messaging.Message<?> requestMessage) -
generateExchangeName
protected java.lang.String generateExchangeName(org.springframework.messaging.Message<?> requestMessage) -
generateRoutingKey
protected java.lang.String generateRoutingKey(org.springframework.messaging.Message<?> requestMessage) -
addDelayProperty
protected void addDelayProperty(org.springframework.messaging.Message<?> message, org.springframework.amqp.core.Message amqpMessage) -
buildReply
protected org.springframework.integration.support.AbstractIntegrationMessageBuilder<?> buildReply(org.springframework.amqp.support.converter.MessageConverter converter, org.springframework.amqp.core.Message amqpReplyMessage) -
buildReturnedMessage
@Deprecated protected org.springframework.messaging.Message<?> buildReturnedMessage(org.springframework.amqp.core.Message message, int replyCode, java.lang.String replyText, java.lang.String exchange, java.lang.String returnedRoutingKey, org.springframework.amqp.support.converter.MessageConverter converter)Deprecated.since 5.4 in favor ofbuildReturnedMessage(ReturnedMessage, MessageConverter)Build Spring message object based on the provided returned AMQP message info.- Parameters:
message- the returned AMQP messagereplyCode- the returned message reason codereplyText- the returned message reason textexchange- the exchange the message returned fromreturnedRoutingKey- the routing key for returned messageconverter- the converter to deserialize body of the returned AMQP message- Returns:
- the Spring message which represents a returned AMQP message
-
buildReturnedMessage
protected org.springframework.messaging.Message<?> buildReturnedMessage(org.springframework.amqp.core.ReturnedMessage returnedMessage, org.springframework.amqp.support.converter.MessageConverter converter) -
handleConfirm
protected void handleConfirm(org.springframework.amqp.rabbit.connection.CorrelationData correlationData, boolean ack, java.lang.String cause)
-