Package org.springframework.amqp.rabbit.core

Class RabbitTemplate

    • Constructor Detail

      • RabbitTemplate

        public RabbitTemplate()
        Convenient constructor for use with setter injection. Don't forget to set the connection factory.

      • RabbitTemplate

        public RabbitTemplate​(ConnectionFactory connectionFactory)
        Create a rabbit template with default strategies and settings.
        Parameters:
        connectionFactory - the connection factory to use

    • Method Detail

      • initDefaultStrategies

        protected void initDefaultStrategies()
        Set up the default strategies. Subclasses can override if necessary.

      • setExchange

        public void setExchange​(@Nullable
                        java.lang.String exchange)
        The name of the default exchange to use for send operations when none is specified. Defaults to "" which is the default exchange in the broker (per the AMQP specification).
        Parameters:
        exchange - the exchange name to use for send operations

      • getExchange

        public java.lang.String getExchange()
        Returns:
        the name of the default exchange used by this template.
        Since:
        1.6

      • setRoutingKey

        public void setRoutingKey​(java.lang.String routingKey)
        The value of a default routing key to use for send operations when none is specified. Default is empty which is not helpful when using the default (or any direct) exchange, but fine if the exchange is a headers exchange for instance.
        Parameters:
        routingKey - the default routing key to use for send operations

      • getRoutingKey

        public java.lang.String getRoutingKey()
        Returns:
        the default routing key used by this template.
        Since:
        1.6

      • setDefaultReceiveQueue

        public void setDefaultReceiveQueue​(java.lang.String queue)
        The name of the default queue to receive messages from when none is specified explicitly.
        Parameters:
        queue - the default queue name to use for receive
        Since:
        2.1.2

      • getDefaultReceiveQueue

        @Nullable
public java.lang.String getDefaultReceiveQueue()
        Return the configured default receive queue.
        Returns:
        the queue or null if not configured.
        Since:
        2.2.22

      • setEncoding

        public void setEncoding​(java.lang.String encoding)
        The encoding to use when converting between byte arrays and Strings in message properties.
        Parameters:
        encoding - the encoding to set

      • getEncoding

        public java.lang.String getEncoding()
        The encoding used when converting between byte arrays and Strings in message properties.
        Returns:
        the encoding.

      • setReplyAddress

        public void setReplyAddress​(java.lang.String replyAddress)
        An address for replies; if not provided, a temporary exclusive, auto-delete queue will be used for each reply, unless RabbitMQ supports 'amq.rabbitmq.reply-to' - see https://www.rabbitmq.com/direct-reply-to.html

        The address can be a simple queue name (in which case the reply will be routed via the default exchange), or with the form exchange/routingKey to route the reply using an explicit exchange and routing key.

        Parameters:
        replyAddress - the replyAddress to set

      • setReceiveTimeout

        public void setReceiveTimeout​(long receiveTimeout)
        Specify the receive timeout in milliseconds when using receive() methods (for sendAndReceive() methods, refer to replyTimeout. By default, the value is zero, which means the receive() methods will return null immediately if there is no message available. Set to less than zero to wait for a message indefinitely.
        Parameters:
        receiveTimeout - the timeout.
        Since:
        1.5

      • setReplyTimeout

        public void setReplyTimeout​(long replyTimeout)
        Specify the timeout in milliseconds to be used when waiting for a reply Message when using one of the sendAndReceive methods. The default value is defined as DEFAULT_REPLY_TIMEOUT. A negative value indicates an indefinite timeout. Not used in the plain receive methods because there is no blocking receive operation defined in the protocol.
        Parameters:
        replyTimeout - the reply timeout in milliseconds
        See Also:
        sendAndReceive(String, String, Message), convertSendAndReceive(String, String, Object)

      • setMessageConverter

        public void setMessageConverter​(MessageConverter messageConverter)
        Set the message converter for this template. Used to resolve Object parameters to convertAndSend methods and Object results from receiveAndConvert methods.

        The default converter is a SimpleMessageConverter, which is able to handle byte arrays, Strings, and Serializable Objects depending on the message content type header.

        Parameters:
        messageConverter - The message converter.
        See Also:
        convertAndSend(java.lang.Object), receiveAndConvert(), SimpleMessageConverter

      • setMessagePropertiesConverter

        public void setMessagePropertiesConverter​(MessagePropertiesConverter messagePropertiesConverter)
        Set the MessagePropertiesConverter for this template. This converter is used to convert between raw byte content in the message headers and plain Java objects. In particular there are limitations when dealing with very long string headers, which hopefully are rare in practice, but if you need to use long headers you might need to inject a special converter here.
        Parameters:
        messagePropertiesConverter - The message properties converter.

      • getMessagePropertiesConverter

        protected MessagePropertiesConverter getMessagePropertiesConverter()
        Return the properties converter.
        Returns:
        the converter.
        Since:
        2.0

      • getMessageConverter

        public MessageConverter getMessageConverter()
        Return the message converter for this template. Useful for clients that want to take advantage of the converter in ChannelCallback implementations.
        Returns:
        The message converter.

      • setMandatory

        public void setMandatory​(boolean mandatory)
        Set the mandatory flag when sending messages; only applies if a returnCallback had been provided.
        Parameters:
        mandatory - the mandatory to set.

      • setMandatoryExpression

        public void setMandatoryExpression​(Expression mandatoryExpression)
        Parameters:
        mandatoryExpression - a SpEL Expression to evaluate against each request message, if a returnCallback has been provided. The result of the evaluation must be a boolean value.
        Since:
        1.4

      • setMandatoryExpressionString

        public void setMandatoryExpressionString​(java.lang.String mandatoryExpression)
        Parameters:
        mandatoryExpression - a SpEL Expression to evaluate against each request message, if a returnCallback has been provided. The result of the evaluation must be a boolean value.
        Since:
        2.0

      • setCorrelationKey

        public void setCorrelationKey​(java.lang.String correlationKey)
        If set to 'correlationId' (default) the correlationId property will be used; otherwise the supplied key will be used.
        Parameters:
        correlationKey - the correlationKey to set

      • setRetryTemplate

        public void setRetryTemplate​(org.springframework.retry.support.RetryTemplate retryTemplate)
        Add a RetryTemplate which will be used for all rabbit operations.
        Parameters:
        retryTemplate - The retry template.

      • setRecoveryCallback

        public void setRecoveryCallback​(org.springframework.retry.RecoveryCallback<?> recoveryCallback)
        Add a RecoveryCallback which is used for the retryTemplate.execute. If retryTemplate isn't provided recoveryCallback is ignored. RecoveryCallback should produce result compatible with execute(ChannelCallback) return type.
        Parameters:
        recoveryCallback - The retry recoveryCallback.
        Since:
        1.4

      • setBeforePublishPostProcessors

        public void setBeforePublishPostProcessors​(MessagePostProcessor... beforePublishPostProcessors)
        Set MessagePostProcessors that will be invoked immediately before invoking Channel#basicPublish(), after all other processing, except creating the AMQP.BasicProperties from MessageProperties. May be used for operations such as compression. Processors are invoked in order, depending on PriorityOrder, Order and finally unordered.
        Parameters:
        beforePublishPostProcessors - the post processor.
        Since:
        1.4.2
        See Also:
        addBeforePublishPostProcessors(MessagePostProcessor...)

      • addBeforePublishPostProcessors

        public void addBeforePublishPostProcessors​(MessagePostProcessor... beforePublishPostProcessors)
        Add MessagePostProcessor that will be invoked immediately before invoking Channel#basicPublish(), after all other processing, except creating the AMQP.BasicProperties from MessageProperties. May be used for operations such as compression. Processors are invoked in order, depending on PriorityOrder, Order and finally unordered.

        In contrast to setBeforePublishPostProcessors(MessagePostProcessor...), this method does not override the previously added beforePublishPostProcessors.

        Parameters:
        beforePublishPostProcessors - the post processor.
        Since:
        2.1.4

      • setAfterReceivePostProcessors

        public void setAfterReceivePostProcessors​(MessagePostProcessor... afterReceivePostProcessors)
        Set a MessagePostProcessor that will be invoked immediately after a Channel#basicGet() and before any message conversion is performed. May be used for operations such as decompression. Processors are invoked in order, depending on PriorityOrder, Order and finally unordered.
        Parameters:
        afterReceivePostProcessors - the post processor.
        Since:
        1.5
        See Also:
        addAfterReceivePostProcessors(MessagePostProcessor...)

      • addAfterReceivePostProcessors

        public void addAfterReceivePostProcessors​(MessagePostProcessor... afterReceivePostProcessors)
        Add MessagePostProcessor that will be invoked immediately after a Channel#basicGet() and before any message conversion is performed. May be used for operations such as decompression. Processors are invoked in order, depending on PriorityOrder, Order and finally unordered.

        In contrast to setAfterReceivePostProcessors(MessagePostProcessor...), this method does not override the previously added afterReceivePostProcessors.

        Parameters:
        afterReceivePostProcessors - the post processor.
        Since:
        2.1.4

      • setUseTemporaryReplyQueues

        public void setUseTemporaryReplyQueues​(boolean value)
        By default, when the broker supports it and no replyAddress is provided, send/receive methods will use Direct reply-to (https://www.rabbitmq.com/direct-reply-to.html). Setting this property to true will override that behavior and use a temporary, auto-delete, queue for each request instead. Changing this property has no effect once the first request has been processed.
        Parameters:
        value - true to use temporary queues.
        Since:
        1.6

      • setUseDirectReplyToContainer

        public void setUseDirectReplyToContainer​(boolean useDirectReplyToContainer)
        Set whether or not to use a DirectReplyToMessageListenerContainer when direct reply-to is available and being used. When false, a new consumer is created for each request (the mechanism used in versions prior to 2.0). Default true.
        Parameters:
        useDirectReplyToContainer - set to false to use a consumer per request.
        Since:
        2.0
        See Also:
        setUseTemporaryReplyQueues(boolean)

      • setUserIdExpression

        public void setUserIdExpression​(Expression userIdExpression)
        Set an expression to be evaluated to set the userId message property if it evaluates to a non-null value and the property is not already set in the message to be sent. See https://www.rabbitmq.com/validated-user-id.html
        Parameters:
        userIdExpression - the expression.
        Since:
        1.6

      • setUserIdExpressionString

        public void setUserIdExpressionString​(java.lang.String userIdExpression)
        Set an expression to be evaluated to set the userId message property if it evaluates to a non-null value and the property is not already set in the message to be sent. See https://www.rabbitmq.com/validated-user-id.html
        Parameters:
        userIdExpression - the expression.
        Since:
        1.6

      • setBeanName

        public void setBeanName​(java.lang.String name)
        Specified by:
        setBeanName in interface BeanNameAware

      • setTaskExecutor

        public void setTaskExecutor​(java.util.concurrent.Executor taskExecutor)
        Set a task executor to use when using a DirectReplyToMessageListenerContainer.
        Parameters:
        taskExecutor - the executor.
        Since:
        2.0

      • setUserCorrelationId

        public void setUserCorrelationId​(boolean userCorrelationId)
        Set to true to use correlation id provided by the message instead of generating the correlation id for request/reply scenarios. The correlation id must be unique for all in-process requests to avoid cross talk.

        Users must therefore take create care to ensure uniqueness.

        Parameters:
        userCorrelationId - true to use user correlation data.

      • isUsePublisherConnection

        public boolean isUsePublisherConnection()
        True if separate publisher connection(s) are used.
        Returns:
        true or false.
        Since:
        2.0.2
        See Also:
        setUsePublisherConnection(boolean)

      • setUsePublisherConnection

        public void setUsePublisherConnection​(boolean usePublisherConnection)
        To avoid deadlocked connections, it is generally recommended to use a separate connection for publishers and consumers (except when a publisher is participating in a consumer transaction). Default 'false'. When setting this to true, be careful in that a RabbitAdmin that uses this template will declare queues on the publisher connection; this may not be what you expect, especially with exclusive queues that might be consumed in this application.
        Parameters:
        usePublisherConnection - true to use a publisher connection.
        Since:
        2.0.2

      • setNoLocalReplyConsumer

        public void setNoLocalReplyConsumer​(boolean noLocalReplyConsumer)
        Set to true for a no-local consumer. Defaults to false.
        Parameters:
        noLocalReplyConsumer - true for a no-local consumer.
        Since:
        2.1
        See Also:
        AbstractMessageListenerContainer.setNoLocal(boolean), Channel.basicConsume(String, boolean, String, boolean, boolean, Map, com.rabbitmq.client.Consumer)

      • setReplyErrorHandler

        public void setReplyErrorHandler​(ErrorHandler replyErrorHandler)
        When using a direct reply-to container for request/reply operations, set an error handler to be invoked when a reply delivery fails (e.g. due to a late reply).
        Parameters:
        replyErrorHandler - the reply error handler
        Since:
        2.0.11
        See Also:
        setUseDirectReplyToContainer(boolean)

      • setUseChannelForCorrelation

        public void setUseChannelForCorrelation​(boolean useChannelForCorrelation)
        When using direct reply-to, set this to true to avoid the server needing to send the correlation id in a reply header. Use the channel to correlate the reply to a request instead.
        Parameters:
        useChannelForCorrelation - true to use the channel.
        Since:
        2.3.7

      • expectedQueueNames

        @Nullable
public java.util.Collection<java.lang.String> expectedQueueNames()
        Invoked by the container during startup so it can verify the queue is correctly configured (if a simple reply queue name is used instead of exchange/routingKey).
        Specified by:
        expectedQueueNames in interface ListenerContainerAware
        Returns:
        the queue name, if configured.
        Since:
        1.5

      • getUnconfirmed

        @Nullable
public java.util.Collection<CorrelationData> getUnconfirmed​(long age)
        Gets unconfirmed correlation data older than age and removes them.
        Parameters:
        age - in milliseconds
        Returns:
        the collection of correlation data for which confirms have not been received or null if no such confirms exist.

      • getUnconfirmedCount

        public int getUnconfirmedCount()
        Gets unconfirmed messages count.
        Returns:
        The count of the messages that are not confirmed yet by RabbitMQ.
        Since:
        2.0

      • addConsumerArg

        public void addConsumerArg​(java.lang.String arg,
                           java.lang.Object value)
        When using receive methods with a non-zero timeout, a Consumer is created to receive the message. Use this property to add arguments to the consumer (e.g. x-priority).
        Parameters:
        arg - the argument name to pass into the basicConsume operation.
        value - the argument value to pass into the basicConsume operation.
        Since:
        2.4.8
        See Also:
        removeConsumerArg(String)

      • removeConsumerArg

        public java.lang.Object removeConsumerArg​(java.lang.String arg)
        When using receive methods with a non-zero timeout, a Consumer is created to receive the message. Use this method to remove an argument from those passed into the basicConsume operation.
        Parameters:
        arg - the argument name.
        Returns:
        the previous value.
        Since:
        2.4.8
        See Also:
        addConsumerArg(String, Object)

      • doStart

        protected void doStart()
        Perform additional start actions.
        Since:
        2.0

      • doStop

        protected void doStop()
        Perform additional stop actions.
        Since:
        2.0

      • useDirectReplyTo

        protected boolean useDirectReplyTo()
        Override this method use some other criteria to decide whether or not to use direct reply-to (https://www.rabbitmq.com/direct-reply-to.html). The default implementation returns true if the broker supports it and there is no replyAddress set and useTemporaryReplyQueues is false. When direct reply-to is not used, the template will create a temporary, exclusive, auto-delete queue for the reply.

        This method is invoked once only - when the first message is sent, from a synchronized block.

        Returns:
        true to use direct reply-to.

      • send

        public void send​(Message message)
          throws AmqpException
        Description copied from interface: AmqpTemplate
        Send a message to a default exchange with a default routing key.
        Specified by:
        send in interface AmqpTemplate
        Parameters:
        message - a message to send
        Throws:
        AmqpException - if there is a problem

      • send

        public void send​(java.lang.String routingKey,
                 Message message)
          throws AmqpException
        Description copied from interface: AmqpTemplate
        Send a message to a default exchange with a specific routing key.
        Specified by:
        send in interface AmqpTemplate
        Parameters:
        routingKey - the routing key
        message - a message to send
        Throws:
        AmqpException - if there is a problem

      • send

        public void send​(java.lang.String routingKey,
                 Message message,
                 CorrelationData correlationData)
          throws AmqpException
        Description copied from interface: RabbitOperations
        Send a message to the default exchange with a specific routing key.
        Specified by:
        send in interface RabbitOperations
        Parameters:
        routingKey - the routing key
        message - a message to send
        correlationData - data to correlate publisher confirms.
        Throws:
        AmqpException - if there is a problem

      • send

        public void send​(java.lang.String exchange,
                 java.lang.String routingKey,
                 Message message)
          throws AmqpException
        Description copied from interface: AmqpTemplate
        Send a message to a specific exchange with a specific routing key.
        Specified by:
        send in interface AmqpTemplate
        Parameters:
        exchange - the name of the exchange
        routingKey - the routing key
        message - a message to send
        Throws:
        AmqpException - if there is a problem

      • send

        public void send​(java.lang.String exchange,
                 java.lang.String routingKey,
                 Message message,
                 @Nullable
                 CorrelationData correlationData)
          throws AmqpException
        Description copied from interface: RabbitOperations
        Send a message to a specific exchange with a specific routing key.
        Specified by:
        send in interface RabbitOperations
        Parameters:
        exchange - the name of the exchange
        routingKey - the routing key
        message - a message to send
        correlationData - data to correlate publisher confirms.
        Throws:
        AmqpException - if there is a problem

      • convertAndSend

        public void convertAndSend​(java.lang.Object object)
                    throws AmqpException
        Description copied from interface: AmqpTemplate
        Convert a Java object to an Amqp Message and send it to a default exchange with a default routing key.
        Specified by:
        convertAndSend in interface AmqpTemplate
        Parameters:
        object - a message to send
        Throws:
        AmqpException - if there is a problem

      • convertAndSend

        public void convertAndSend​(java.lang.String routingKey,
                           java.lang.Object object)
                    throws AmqpException
        Description copied from interface: AmqpTemplate
        Convert a Java object to an Amqp Message and send it to a default exchange with a specific routing key.
        Specified by:
        convertAndSend in interface AmqpTemplate
        Parameters:
        routingKey - the routing key
        object - a message to send
        Throws:
        AmqpException - if there is a problem

      • convertAndSend

        public void convertAndSend​(java.lang.String routingKey,
                           java.lang.Object object,
                           CorrelationData correlationData)
                    throws AmqpException
        Description copied from interface: RabbitOperations
        Convert a Java object to an Amqp Message and send it to a default exchange with a specific routing key.
        Specified by:
        convertAndSend in interface RabbitOperations
        Parameters:
        routingKey - the routing key
        object - a message to send
        correlationData - data to correlate publisher confirms.
        Throws:
        AmqpException - if there is a problem

      • convertAndSend

        public void convertAndSend​(java.lang.String exchange,
                           java.lang.String routingKey,
                           java.lang.Object object)
                    throws AmqpException
        Description copied from interface: AmqpTemplate
        Convert a Java object to an Amqp Message and send it to a specific exchange with a specific routing key.
        Specified by:
        convertAndSend in interface AmqpTemplate
        Parameters:
        exchange - the name of the exchange
        routingKey - the routing key
        object - a message to send
        Throws:
        AmqpException - if there is a problem

      • convertAndSend

        public void convertAndSend​(java.lang.String exchange,
                           java.lang.String routingKey,
                           java.lang.Object object,
                           @Nullable
                           CorrelationData correlationData)
                    throws AmqpException
        Description copied from interface: RabbitOperations
        Convert a Java object to an Amqp Message and send it to a specific exchange with a specific routing key.
        Specified by:
        convertAndSend in interface RabbitOperations
        Parameters:
        exchange - the name of the exchange
        routingKey - the routing key
        object - a message to send
        correlationData - data to correlate publisher confirms.
        Throws:
        AmqpException - if there is a problem

      • convertAndSend

        public void convertAndSend​(java.lang.Object message,
                           MessagePostProcessor messagePostProcessor)
                    throws AmqpException
        Description copied from interface: AmqpTemplate
        Convert a Java object to an Amqp Message and send it to a default exchange with a default routing key.
        Specified by:
        convertAndSend in interface AmqpTemplate
        Parameters:
        message - a message to send
        messagePostProcessor - a processor to apply to the message before it is sent
        Throws:
        AmqpException - if there is a problem

      • convertAndSend

        public void convertAndSend​(java.lang.String routingKey,
                           java.lang.Object message,
                           MessagePostProcessor messagePostProcessor)
                    throws AmqpException
        Description copied from interface: AmqpTemplate
        Convert a Java object to an Amqp Message and send it to a default exchange with a specific routing key.
        Specified by:
        convertAndSend in interface AmqpTemplate
        Parameters:
        routingKey - the routing key
        message - a message to send
        messagePostProcessor - a processor to apply to the message before it is sent
        Throws:
        AmqpException - if there is a problem

      • convertAndSend

        public void convertAndSend​(java.lang.Object message,
                           MessagePostProcessor messagePostProcessor,
                           CorrelationData correlationData)
                    throws AmqpException
        Description copied from interface: RabbitOperations
        Convert a Java object to an Amqp Message and send it to a default exchange with a default routing key.
        Specified by:
        convertAndSend in interface RabbitOperations
        Parameters:
        message - a message to send
        messagePostProcessor - a processor to apply to the message before it is sent
        correlationData - data to correlate publisher confirms.
        Throws:
        AmqpException - if there is a problem

      • convertAndSend

        public void convertAndSend​(java.lang.String routingKey,
                           java.lang.Object message,
                           MessagePostProcessor messagePostProcessor,
                           CorrelationData correlationData)
                    throws AmqpException
        Description copied from interface: RabbitOperations
        Convert a Java object to an Amqp Message and send it to a default exchange with a specific routing key.
        Specified by:
        convertAndSend in interface RabbitOperations
        Parameters:
        routingKey - the routing key
        message - a message to send
        messagePostProcessor - a processor to apply to the message before it is sent
        correlationData - data to correlate publisher confirms.
        Throws:
        AmqpException - if there is a problem

      • convertAndSend

        public void convertAndSend​(java.lang.String exchange,
                           java.lang.String routingKey,
                           java.lang.Object message,
                           MessagePostProcessor messagePostProcessor)
                    throws AmqpException
        Description copied from interface: AmqpTemplate
        Convert a Java object to an Amqp Message and send it to a specific exchange with a specific routing key.
        Specified by:
        convertAndSend in interface AmqpTemplate
        Parameters:
        exchange - the name of the exchange
        routingKey - the routing key
        message - a message to send
        messagePostProcessor - a processor to apply to the message before it is sent
        Throws:
        AmqpException - if there is a problem

      • convertAndSend

        public void convertAndSend​(java.lang.String exchange,
                           java.lang.String routingKey,
                           java.lang.Object message,
                           MessagePostProcessor messagePostProcessor,
                           @Nullable
                           CorrelationData correlationData)
                    throws AmqpException
        Description copied from interface: RabbitOperations
        Convert a Java object to an Amqp Message and send it to a specific exchange with a specific routing key.
        Specified by:
        convertAndSend in interface RabbitOperations
        Parameters:
        exchange - the name of the exchange
        routingKey - the routing key
        message - a message to send
        messagePostProcessor - a processor to apply to the message before it is sent
        correlationData - data to correlate publisher confirms.
        Throws:
        AmqpException - if there is a problem

      • receive

        @Nullable
public Message receive()
                throws AmqpException
        Description copied from interface: AmqpTemplate
        Receive a message if there is one from a default queue. Returns immediately, possibly with a null value.
        Specified by:
        receive in interface AmqpTemplate
        Returns:
        a message or null if there is none waiting
        Throws:
        AmqpException - if there is a problem

      • receive

        @Nullable
public Message receive​(java.lang.String queueName)
        Description copied from interface: AmqpTemplate
        Receive a message if there is one from a specific queue. Returns immediately, possibly with a null value.
        Specified by:
        receive in interface AmqpTemplate
        Parameters:
        queueName - the name of the queue to poll
        Returns:
        a message or null if there is none waiting

      • doReceiveNoWait

        @Nullable
protected Message doReceiveNoWait​(java.lang.String queueName)
        Non-blocking receive.
        Parameters:
        queueName - the queue to receive from.
        Returns:
        The message, or null if none immediately available.
        Since:
        1.5

      • receive

        @Nullable
public Message receive​(long timeoutMillis)
                throws AmqpException
        Description copied from interface: AmqpTemplate
        Receive a message from a default queue, waiting up to the specified wait time if necessary for a message to become available.
        Specified by:
        receive in interface AmqpTemplate
        Parameters:
        timeoutMillis - how long to wait before giving up. Zero value means the method will return null immediately if there is no message available. Negative value makes method wait for a message indefinitely.
        Returns:
        a message or null if the time expires
        Throws:
        AmqpException - if there is a problem

      • receive

        @Nullable
public Message receive​(java.lang.String queueName,
                       long timeoutMillis)
        Description copied from interface: AmqpTemplate
        Receive a message from a specific queue, waiting up to the specified wait time if necessary for a message to become available.
        Specified by:
        receive in interface AmqpTemplate
        Parameters:
        queueName - the queue to receive from
        timeoutMillis - how long to wait before giving up. Zero value means the method will return null immediately if there is no message available. Negative value makes method wait for a message indefinitely.
        Returns:
        a message or null if the time expires

      • receiveAndConvert

        @Nullable
public java.lang.Object receiveAndConvert()
                                   throws AmqpException
        Description copied from interface: AmqpTemplate
        Receive a message if there is one from a default queue and convert it to a Java object. Returns immediately, possibly with a null value.
        Specified by:
        receiveAndConvert in interface AmqpTemplate
        Returns:
        a message or null if there is none waiting
        Throws:
        AmqpException - if there is a problem

      • receiveAndConvert

        @Nullable
public java.lang.Object receiveAndConvert​(java.lang.String queueName)
                                   throws AmqpException
        Description copied from interface: AmqpTemplate
        Receive a message if there is one from a specific queue and convert it to a Java object. Returns immediately, possibly with a null value.
        Specified by:
        receiveAndConvert in interface AmqpTemplate
        Parameters:
        queueName - the name of the queue to poll
        Returns:
        a message or null if there is none waiting
        Throws:
        AmqpException - if there is a problem

      • receiveAndConvert

        @Nullable
public java.lang.Object receiveAndConvert​(long timeoutMillis)
                                   throws AmqpException
        Description copied from interface: AmqpTemplate
        Receive a message if there is one from a default queue and convert it to a Java object. Wait up to the specified wait time if necessary for a message to become available.
        Specified by:
        receiveAndConvert in interface AmqpTemplate
        Parameters:
        timeoutMillis - how long to wait before giving up. Zero value means the method will return null immediately if there is no message available. Negative value makes method wait for a message indefinitely.
        Returns:
        a message or null if the time expires
        Throws:
        AmqpException - if there is a problem

      • receiveAndConvert

        @Nullable
public java.lang.Object receiveAndConvert​(java.lang.String queueName,
                                          long timeoutMillis)
                                   throws AmqpException
        Description copied from interface: AmqpTemplate
        Receive a message if there is one from a specific queue and convert it to a Java object. Wait up to the specified wait time if necessary for a message to become available.
        Specified by:
        receiveAndConvert in interface AmqpTemplate
        Parameters:
        queueName - the name of the queue to poll
        timeoutMillis - how long to wait before giving up. Zero value means the method will return null immediately if there is no message available. Negative value makes method wait for a message indefinitely.
        Returns:
        a message or null if the time expires
        Throws:
        AmqpException - if there is a problem

      • receiveAndConvert

        @Nullable
public <T> T receiveAndConvert​(java.lang.String queueName,
                               ParameterizedTypeReference<T> type)
                        throws AmqpException
        Description copied from interface: AmqpTemplate
        Receive a message if there is one from a specific queue and convert it to a Java object. Returns immediately, possibly with a null value. Requires a SmartMessageConverter.
        Specified by:
        receiveAndConvert in interface AmqpTemplate
        Type Parameters:
        T - the type.
        Parameters:
        queueName - the name of the queue to poll
        type - the type to convert to.
        Returns:
        a message or null if there is none waiting
        Throws:
        AmqpException - if there is a problem

      • receiveAndConvert

        @Nullable
public <T> T receiveAndConvert​(long timeoutMillis,
                               ParameterizedTypeReference<T> type)
                        throws AmqpException
        Description copied from interface: AmqpTemplate
        Receive a message if there is one from a default queue and convert it to a Java object. Wait up to the specified wait time if necessary for a message to become available. Requires a SmartMessageConverter.
        Specified by:
        receiveAndConvert in interface AmqpTemplate
        Type Parameters:
        T - the type.
        Parameters:
        timeoutMillis - how long to wait before giving up. Zero value means the method will return null immediately if there is no message available. Negative value makes method wait for a message indefinitely.
        type - the type to convert to.
        Returns:
        a message or null if the time expires
        Throws:
        AmqpException - if there is a problem

      • receiveAndConvert

        @Nullable
public <T> T receiveAndConvert​(java.lang.String queueName,
                               long timeoutMillis,
                               ParameterizedTypeReference<T> type)
                        throws AmqpException
        Description copied from interface: AmqpTemplate
        Receive a message if there is one from a specific queue and convert it to a Java object. Wait up to the specified wait time if necessary for a message to become available. Requires a SmartMessageConverter.
        Specified by:
        receiveAndConvert in interface AmqpTemplate
        Type Parameters:
        T - the type.
        Parameters:
        queueName - the name of the queue to poll
        timeoutMillis - how long to wait before giving up. Zero value means the method will return null immediately if there is no message available. Negative value makes method wait for a message indefinitely.
        type - the type to convert to.
        Returns:
        a message or null if the time expires
        Throws:
        AmqpException - if there is a problem

      • receiveAndReply

        public <R,​S> boolean receiveAndReply​(java.lang.String queueName,
                                           ReceiveAndReplyCallback<R,​S> callback)
                                    throws AmqpException
        Description copied from interface: AmqpTemplate
        Receive a message if there is one from provided queue, invoke provided ReceiveAndReplyCallback and send reply message, if the callback returns one, to the replyTo Address from MessageProperties or to default exchange and default routingKey.
        Specified by:
        receiveAndReply in interface AmqpTemplate
        Type Parameters:
        R - The type of the request after conversion from the Message.
        S - The type of the response.
        Parameters:
        queueName - the queue name to receive a message.
        callback - a user-provided ReceiveAndReplyCallback implementation to process received message and return a reply message.
        Returns:
        true, if message was received.
        Throws:
        AmqpException - if there is a problem.

      • receiveAndReply

        public <R,​S> boolean receiveAndReply​(ReceiveAndReplyCallback<R,​S> callback,
                                           java.lang.String exchange,
                                           java.lang.String routingKey)
                                    throws AmqpException
        Description copied from interface: AmqpTemplate
        Receive a message if there is one from default queue, invoke provided ReceiveAndReplyCallback and send reply message, if the callback returns one, to the provided exchange and routingKey.
        Specified by:
        receiveAndReply in interface AmqpTemplate
        Type Parameters:
        R - The type of the request after conversion from the Message.
        S - The type of the response.
        Parameters:
        callback - a user-provided ReceiveAndReplyCallback implementation to process received message and return a reply message.
        exchange - the exchange name to send reply message.
        routingKey - the routing key to send reply message.
        Returns:
        true, if message was received.
        Throws:
        AmqpException - if there is a problem.

      • receiveAndReply

        public <R,​S> boolean receiveAndReply​(java.lang.String queueName,
                                           ReceiveAndReplyCallback<R,​S> callback,
                                           java.lang.String replyExchange,
                                           java.lang.String replyRoutingKey)
                                    throws AmqpException
        Description copied from interface: AmqpTemplate
        Receive a message if there is one from provided queue, invoke provided ReceiveAndReplyCallback and send reply message, if the callback returns one, to the provided exchange and routingKey.
        Specified by:
        receiveAndReply in interface AmqpTemplate
        Type Parameters:
        R - The type of the request after conversion from the Message.
        S - The type of the response.
        Parameters:
        queueName - the queue name to receive a message.
        callback - a user-provided ReceiveAndReplyCallback implementation to process received message and return a reply message.
        replyExchange - the exchange name to send reply message.
        replyRoutingKey - the routing key to send reply message.
        Returns:
        true, if message was received
        Throws:
        AmqpException - if there is a problem

      • receiveAndReply

        public <R,​S> boolean receiveAndReply​(java.lang.String queueName,
                                           ReceiveAndReplyCallback<R,​S> callback,
                                           ReplyToAddressCallback<S> replyToAddressCallback)
                                    throws AmqpException
        Description copied from interface: AmqpTemplate
        Receive a message if there is one from provided queue, invoke provided ReceiveAndReplyCallback and send reply message, if the callback returns one, to the replyTo Address from result of ReplyToAddressCallback.
        Specified by:
        receiveAndReply in interface AmqpTemplate
        Type Parameters:
        R - The type of the request after conversion from the Message.
        S - The type of the response.
        Parameters:
        queueName - the queue name to receive a message.
        callback - a user-provided ReceiveAndReplyCallback implementation to process received message and return a reply message.
        replyToAddressCallback - the callback to determine replyTo address at runtime.
        Returns:
        true, if message was received
        Throws:
        AmqpException - if there is a problem

      • logReceived

        protected void logReceived​(java.lang.String prefix,
                           @Nullable
                           Message message)
        Log a received message. The default implementation logs the full message at DEBUG level. Override this method to change that behavior.
        Parameters:
        prefix - a prefix, e.g. "Received: " or "Reply: ".
        message - the message.
        Since:
        2.4.6

      • sendAndReceive

        @Nullable
public Message sendAndReceive​(Message message)
                       throws AmqpException
        Description copied from interface: AmqpTemplate
        Basic RPC pattern. Send a message to a default exchange with a default routing key and attempt to receive a response. Implementations will normally set the reply-to header to an exclusive queue and wait up for some time limited by a timeout.
        Specified by:
        sendAndReceive in interface AmqpTemplate
        Parameters:
        message - a message to send
        Returns:
        the response if there is one
        Throws:
        AmqpException - if there is a problem

      • sendAndReceive

        @Nullable
public Message sendAndReceive​(java.lang.String routingKey,
                              Message message)
                       throws AmqpException
        Description copied from interface: AmqpTemplate
        Basic RPC pattern. Send a message to a default exchange with a specific routing key and attempt to receive a response. Implementations will normally set the reply-to header to an exclusive queue and wait up for some time limited by a timeout.
        Specified by:
        sendAndReceive in interface AmqpTemplate
        Parameters:
        routingKey - the routing key
        message - a message to send
        Returns:
        the response if there is one
        Throws:
        AmqpException - if there is a problem

      • sendAndReceive

        @Nullable
public Message sendAndReceive​(java.lang.String exchange,
                              java.lang.String routingKey,
                              Message message)
                       throws AmqpException
        Description copied from interface: AmqpTemplate
        Basic RPC pattern. Send a message to a specific exchange with a specific routing key and attempt to receive a response. Implementations will normally set the reply-to header to an exclusive queue and wait up for some time limited by a timeout.
        Specified by:
        sendAndReceive in interface AmqpTemplate
        Parameters:
        exchange - the name of the exchange
        routingKey - the routing key
        message - a message to send
        Returns:
        the response if there is one
        Throws:
        AmqpException - if there is a problem

      • convertSendAndReceive

        @Nullable
public java.lang.Object convertSendAndReceive​(java.lang.Object message)
                                       throws AmqpException
        Description copied from interface: AmqpTemplate
        Basic RPC pattern with conversion. Send a Java object converted to a message to a default exchange with a default routing key and attempt to receive a response, converting that to a Java object. Implementations will normally set the reply-to header to an exclusive queue and wait up for some time limited by a timeout.
        Specified by:
        convertSendAndReceive in interface AmqpTemplate
        Parameters:
        message - a message to send
        Returns:
        the response if there is one
        Throws:
        AmqpException - if there is a problem

      • convertSendAndReceive

        @Nullable
public java.lang.Object convertSendAndReceive​(java.lang.Object message,
                                              @Nullable
                                              CorrelationData correlationData)
                                       throws AmqpException
        Description copied from interface: RabbitOperations
        Basic RPC pattern with conversion. Send a Java object converted to a message to a default exchange with a default routing key and attempt to receive a response, converting that to a Java object. Implementations will normally set the reply-to header to an exclusive queue and wait up for some time limited by a timeout.
        Specified by:
        convertSendAndReceive in interface RabbitOperations
        Parameters:
        message - a message to send.
        correlationData - data to correlate publisher confirms.
        Returns:
        the response if there is one
        Throws:
        AmqpException - if there is a problem

      • convertSendAndReceive

        @Nullable
public java.lang.Object convertSendAndReceive​(java.lang.String routingKey,
                                              java.lang.Object message)
                                       throws AmqpException
        Description copied from interface: AmqpTemplate
        Basic RPC pattern with conversion. Send a Java object converted to a message to a default exchange with a specific routing key and attempt to receive a response, converting that to a Java object. Implementations will normally set the reply-to header to an exclusive queue and wait up for some time limited by a timeout.
        Specified by:
        convertSendAndReceive in interface AmqpTemplate
        Parameters:
        routingKey - the routing key
        message - a message to send
        Returns:
        the response if there is one
        Throws:
        AmqpException - if there is a problem

      • convertSendAndReceive

        @Nullable
public java.lang.Object convertSendAndReceive​(java.lang.String routingKey,
                                              java.lang.Object message,
                                              @Nullable
                                              CorrelationData correlationData)
                                       throws AmqpException
        Description copied from interface: RabbitOperations
        Basic RPC pattern with conversion. Send a Java object converted to a message to a default exchange with a specific routing key and attempt to receive a response, converting that to a Java object. Implementations will normally set the reply-to header to an exclusive queue and wait up for some time limited by a timeout.
        Specified by:
        convertSendAndReceive in interface RabbitOperations
        Parameters:
        routingKey - the routing key
        message - a message to send
        correlationData - data to correlate publisher confirms.
        Returns:
        the response if there is one
        Throws:
        AmqpException - if there is a problem

      • convertSendAndReceive

        @Nullable
public java.lang.Object convertSendAndReceive​(java.lang.String exchange,
                                              java.lang.String routingKey,
                                              java.lang.Object message)
                                       throws AmqpException
        Description copied from interface: AmqpTemplate
        Basic RPC pattern with conversion. Send a Java object converted to a message to a specific exchange with a specific routing key and attempt to receive a response, converting that to a Java object. Implementations will normally set the reply-to header to an exclusive queue and wait up for some time limited by a timeout.
        Specified by:
        convertSendAndReceive in interface AmqpTemplate
        Parameters:
        exchange - the name of the exchange
        routingKey - the routing key
        message - a message to send
        Returns:
        the response if there is one
        Throws:
        AmqpException - if there is a problem

      • convertSendAndReceive

        @Nullable
public java.lang.Object convertSendAndReceive​(java.lang.String exchange,
                                              java.lang.String routingKey,
                                              java.lang.Object message,
                                              @Nullable
                                              CorrelationData correlationData)
                                       throws AmqpException
        Description copied from interface: RabbitOperations
        Basic RPC pattern with conversion. Send a Java object converted to a message to a specific exchange with a specific routing key and attempt to receive a response, converting that to a Java object. Implementations will normally set the reply-to header to an exclusive queue and wait up for some time limited by a timeout.
        Specified by:
        convertSendAndReceive in interface RabbitOperations
        Parameters:
        exchange - the name of the exchange
        routingKey - the routing key
        message - a message to send
        correlationData - data to correlate publisher confirms.
        Returns:
        the response if there is one
        Throws:
        AmqpException - if there is a problem

      • convertSendAndReceive

        @Nullable
public java.lang.Object convertSendAndReceive​(java.lang.Object message,
                                              MessagePostProcessor messagePostProcessor)
                                       throws AmqpException
        Description copied from interface: AmqpTemplate
        Basic RPC pattern with conversion. Send a Java object converted to a message to a default exchange with a default routing key and attempt to receive a response, converting that to a Java object. Implementations will normally set the reply-to header to an exclusive queue and wait up for some time limited by a timeout.
        Specified by:
        convertSendAndReceive in interface AmqpTemplate
        Parameters:
        message - a message to send
        messagePostProcessor - a processor to apply to the message before it is sent
        Returns:
        the response if there is one
        Throws:
        AmqpException - if there is a problem

      • convertSendAndReceive

        @Nullable
public java.lang.Object convertSendAndReceive​(java.lang.Object message,
                                              MessagePostProcessor messagePostProcessor,
                                              @Nullable
                                              CorrelationData correlationData)
                                       throws AmqpException
        Description copied from interface: RabbitOperations
        Basic RPC pattern with conversion. Send a Java object converted to a message to a default exchange with a default routing key and attempt to receive a response, converting that to a Java object. Implementations will normally set the reply-to header to an exclusive queue and wait up for some time limited by a timeout.
        Specified by:
        convertSendAndReceive in interface RabbitOperations
        Parameters:
        message - a message to send
        messagePostProcessor - a processor to apply to the message before it is sent
        correlationData - data to correlate publisher confirms.
        Returns:
        the response if there is one
        Throws:
        AmqpException - if there is a problem

      • convertSendAndReceive

        @Nullable
public java.lang.Object convertSendAndReceive​(java.lang.String routingKey,
                                              java.lang.Object message,
                                              MessagePostProcessor messagePostProcessor)
                                       throws AmqpException
        Description copied from interface: AmqpTemplate
        Basic RPC pattern with conversion. Send a Java object converted to a message to a default exchange with a specific routing key and attempt to receive a response, converting that to a Java object. Implementations will normally set the reply-to header to an exclusive queue and wait up for some time limited by a timeout.
        Specified by:
        convertSendAndReceive in interface AmqpTemplate
        Parameters:
        routingKey - the routing key
        message - a message to send
        messagePostProcessor - a processor to apply to the message before it is sent
        Returns:
        the response if there is one
        Throws:
        AmqpException - if there is a problem

      • convertSendAndReceive

        @Nullable
public java.lang.Object convertSendAndReceive​(java.lang.String routingKey,
                                              java.lang.Object message,
                                              MessagePostProcessor messagePostProcessor,
                                              @Nullable
                                              CorrelationData correlationData)
                                       throws AmqpException
        Description copied from interface: RabbitOperations
        Basic RPC pattern with conversion. Send a Java object converted to a message to a default exchange with a specific routing key and attempt to receive a response, converting that to a Java object. Implementations will normally set the reply-to header to an exclusive queue and wait up for some time limited by a timeout.
        Specified by:
        convertSendAndReceive in interface RabbitOperations
        Parameters:
        routingKey - the routing key
        message - a message to send
        messagePostProcessor - a processor to apply to the message before it is sent
        correlationData - data to correlate publisher confirms.
        Returns:
        the response if there is one
        Throws:
        AmqpException - if there is a problem

      • convertSendAndReceive

        @Nullable
public java.lang.Object convertSendAndReceive​(java.lang.String exchange,
                                              java.lang.String routingKey,
                                              java.lang.Object message,
                                              MessagePostProcessor messagePostProcessor)
                                       throws AmqpException
        Description copied from interface: AmqpTemplate
        Basic RPC pattern with conversion. Send a Java object converted to a message to a specific exchange with a specific routing key and attempt to receive a response, converting that to a Java object. Implementations will normally set the reply-to header to an exclusive queue and wait up for some time limited by a timeout.
        Specified by:
        convertSendAndReceive in interface AmqpTemplate
        Parameters:
        exchange - the name of the exchange
        routingKey - the routing key
        message - a message to send
        messagePostProcessor - a processor to apply to the message before it is sent
        Returns:
        the response if there is one
        Throws:
        AmqpException - if there is a problem

      • convertSendAndReceive

        @Nullable
public java.lang.Object convertSendAndReceive​(java.lang.String exchange,
                                              java.lang.String routingKey,
                                              java.lang.Object message,
                                              @Nullable
                                              MessagePostProcessor messagePostProcessor,
                                              @Nullable
                                              CorrelationData correlationData)
                                       throws AmqpException
        Description copied from interface: RabbitOperations
        Basic RPC pattern with conversion. Send a Java object converted to a message to a specific exchange with a specific routing key and attempt to receive a response, converting that to a Java object. Implementations will normally set the reply-to header to an exclusive queue and wait up for some time limited by a timeout.
        Specified by:
        convertSendAndReceive in interface RabbitOperations
        Parameters:
        exchange - the name of the exchange
        routingKey - the routing key
        message - a message to send
        messagePostProcessor - a processor to apply to the message before it is sent
        correlationData - data to correlate publisher confirms.
        Returns:
        the response if there is one
        Throws:
        AmqpException - if there is a problem

      • convertSendAndReceiveAsType

        @Nullable
public <T> T convertSendAndReceiveAsType​(java.lang.Object message,
                                         ParameterizedTypeReference<T> responseType)
                                  throws AmqpException
        Description copied from interface: AmqpTemplate
        Basic RPC pattern with conversion. Send a Java object converted to a message to a default exchange with a default routing key and attempt to receive a response, converting that to a Java object. Implementations will normally set the reply-to header to an exclusive queue and wait up for some time limited by a timeout. Requires a SmartMessageConverter.
        Specified by:
        convertSendAndReceiveAsType in interface AmqpTemplate
        Type Parameters:
        T - the type.
        Parameters:
        message - a message to send.
        responseType - the type to convert the reply to.
        Returns:
        the response if there is one.
        Throws:
        AmqpException - if there is a problem.

      • convertSendAndReceiveAsType

        @Nullable
public <T> T convertSendAndReceiveAsType​(java.lang.Object message,
                                         @Nullable
                                         CorrelationData correlationData,
                                         ParameterizedTypeReference<T> responseType)
                                  throws AmqpException
        Description copied from interface: RabbitOperations
        Basic RPC pattern with conversion. Send a Java object converted to a message to a default exchange with a default routing key and attempt to receive a response, converting that to a Java object. Implementations will normally set the reply-to header to an exclusive queue and wait up for some time limited by a timeout. Requires a SmartMessageConverter.
        Specified by:
        convertSendAndReceiveAsType in interface RabbitOperations
        Type Parameters:
        T - the type.
        Parameters:
        message - a message to send.
        correlationData - data to correlate publisher confirms.
        responseType - the type to convert the reply to.
        Returns:
        the response if there is one.
        Throws:
        AmqpException - if there is a problem.

      • convertSendAndReceiveAsType

        @Nullable
public <T> T convertSendAndReceiveAsType​(java.lang.String routingKey,
                                         java.lang.Object message,
                                         ParameterizedTypeReference<T> responseType)
                                  throws AmqpException
        Description copied from interface: AmqpTemplate
        Basic RPC pattern with conversion. Send a Java object converted to a message to a default exchange with a specific routing key and attempt to receive a response, converting that to a Java object. Implementations will normally set the reply-to header to an exclusive queue and wait up for some time limited by a timeout. Requires a SmartMessageConverter.
        Specified by:
        convertSendAndReceiveAsType in interface AmqpTemplate
        Type Parameters:
        T - the type.
        Parameters:
        routingKey - the routing key
        message - a message to send
        responseType - the type to convert the reply to.
        Returns:
        the response if there is one
        Throws:
        AmqpException - if there is a problem

      • convertSendAndReceiveAsType

        @Nullable
public <T> T convertSendAndReceiveAsType​(java.lang.String routingKey,
                                         java.lang.Object message,
                                         @Nullable
                                         CorrelationData correlationData,
                                         ParameterizedTypeReference<T> responseType)
                                  throws AmqpException
        Description copied from interface: RabbitOperations
        Basic RPC pattern with conversion. Send a Java object converted to a message to a default exchange with a specific routing key and attempt to receive a response, converting that to a Java object. Implementations will normally set the reply-to header to an exclusive queue and wait up for some time limited by a timeout. Requires a SmartMessageConverter.
        Specified by:
        convertSendAndReceiveAsType in interface RabbitOperations
        Type Parameters:
        T - the type.
        Parameters:
        routingKey - the routing key
        message - a message to send
        correlationData - data to correlate publisher confirms.
        responseType - the type to convert the reply to.
        Returns:
        the response if there is one
        Throws:
        AmqpException - if there is a problem

      • convertSendAndReceiveAsType

        @Nullable
public <T> T convertSendAndReceiveAsType​(java.lang.String exchange,
                                         java.lang.String routingKey,
                                         java.lang.Object message,
                                         ParameterizedTypeReference<T> responseType)
                                  throws AmqpException
        Description copied from interface: AmqpTemplate
        Basic RPC pattern with conversion. Send a Java object converted to a message to a specific exchange with a specific routing key and attempt to receive a response, converting that to a Java object. Implementations will normally set the reply-to header to an exclusive queue and wait up for some time limited by a timeout. Requires a SmartMessageConverter.
        Specified by:
        convertSendAndReceiveAsType in interface AmqpTemplate
        Type Parameters:
        T - the type.
        Parameters:
        exchange - the name of the exchange
        routingKey - the routing key
        message - a message to send
        responseType - the type to convert the reply to.
        Returns:
        the response if there is one
        Throws:
        AmqpException - if there is a problem

      • convertSendAndReceiveAsType

        @Nullable
public <T> T convertSendAndReceiveAsType​(java.lang.Object message,
                                         @Nullable
                                         MessagePostProcessor messagePostProcessor,
                                         ParameterizedTypeReference<T> responseType)
                                  throws AmqpException
        Description copied from interface: AmqpTemplate
        Basic RPC pattern with conversion. Send a Java object converted to a message to a default exchange with a default routing key and attempt to receive a response, converting that to a Java object. Implementations will normally set the reply-to header to an exclusive queue and wait up for some time limited by a timeout. Requires a SmartMessageConverter.
        Specified by:
        convertSendAndReceiveAsType in interface AmqpTemplate
        Type Parameters:
        T - the type.
        Parameters:
        message - a message to send
        messagePostProcessor - a processor to apply to the message before it is sent
        responseType - the type to convert the reply to.
        Returns:
        the response if there is one
        Throws:
        AmqpException - if there is a problem

      • convertSendAndReceiveAsType

        @Nullable
public <T> T convertSendAndReceiveAsType​(java.lang.Object message,
                                         @Nullable
                                         MessagePostProcessor messagePostProcessor,
                                         @Nullable
                                         CorrelationData correlationData,
                                         ParameterizedTypeReference<T> responseType)
                                  throws AmqpException
        Description copied from interface: RabbitOperations
        Basic RPC pattern with conversion. Send a Java object converted to a message to a default exchange with a default routing key and attempt to receive a response, converting that to a Java object. Implementations will normally set the reply-to header to an exclusive queue and wait up for some time limited by a timeout. Requires a SmartMessageConverter.
        Specified by:
        convertSendAndReceiveAsType in interface RabbitOperations
        Type Parameters:
        T - the type.
        Parameters:
        message - a message to send
        messagePostProcessor - a processor to apply to the message before it is sent
        correlationData - data to correlate publisher confirms.
        responseType - the type to convert the reply to.
        Returns:
        the response if there is one
        Throws:
        AmqpException - if there is a problem

      • convertSendAndReceiveAsType

        @Nullable
public <T> T convertSendAndReceiveAsType​(java.lang.String routingKey,
                                         java.lang.Object message,
                                         @Nullable
                                         MessagePostProcessor messagePostProcessor,
                                         ParameterizedTypeReference<T> responseType)
                                  throws AmqpException
        Description copied from interface: AmqpTemplate
        Basic RPC pattern with conversion. Send a Java object converted to a message to a default exchange with a specific routing key and attempt to receive a response, converting that to a Java object. Implementations will normally set the reply-to header to an exclusive queue and wait up for some time limited by a timeout. Requires a SmartMessageConverter.
        Specified by:
        convertSendAndReceiveAsType in interface AmqpTemplate
        Type Parameters:
        T - the type.
        Parameters:
        routingKey - the routing key
        message - a message to send
        messagePostProcessor - a processor to apply to the message before it is sent
        responseType - the type to convert the reply to.
        Returns:
        the response if there is one
        Throws:
        AmqpException - if there is a problem

      • convertSendAndReceiveAsType

        @Nullable
public <T> T convertSendAndReceiveAsType​(java.lang.String routingKey,
                                         java.lang.Object message,
                                         @Nullable
                                         MessagePostProcessor messagePostProcessor,
                                         @Nullable
                                         CorrelationData correlationData,
                                         ParameterizedTypeReference<T> responseType)
                                  throws AmqpException
        Description copied from interface: RabbitOperations
        Basic RPC pattern with conversion. Send a Java object converted to a message to a default exchange with a specific routing key and attempt to receive a response, converting that to a Java object. Implementations will normally set the reply-to header to an exclusive queue and wait up for some time limited by a timeout. Requires a SmartMessageConverter.
        Specified by:
        convertSendAndReceiveAsType in interface RabbitOperations
        Type Parameters:
        T - the type.
        Parameters:
        routingKey - the routing key
        message - a message to send
        messagePostProcessor - a processor to apply to the message before it is sent
        correlationData - data to correlate publisher confirms.
        responseType - the type to convert the reply to.
        Returns:
        the response if there is one
        Throws:
        AmqpException - if there is a problem

      • convertSendAndReceiveAsType

        @Nullable
public <T> T convertSendAndReceiveAsType​(java.lang.String exchange,
                                         java.lang.String routingKey,
                                         java.lang.Object message,
                                         MessagePostProcessor messagePostProcessor,
                                         ParameterizedTypeReference<T> responseType)
                                  throws AmqpException
        Description copied from interface: AmqpTemplate
        Basic RPC pattern with conversion. Send a Java object converted to a message to a specific exchange with a specific routing key and attempt to receive a response, converting that to a Java object. Implementations will normally set the reply-to header to an exclusive queue and wait up for some time limited by a timeout. Requires a SmartMessageConverter.
        Specified by:
        convertSendAndReceiveAsType in interface AmqpTemplate
        Type Parameters:
        T - the type.
        Parameters:
        exchange - the name of the exchange
        routingKey - the routing key
        message - a message to send
        messagePostProcessor - a processor to apply to the message before it is sent
        responseType - the type to convert the reply to.
        Returns:
        the response if there is one
        Throws:
        AmqpException - if there is a problem

      • convertSendAndReceiveAsType

        @Nullable
public <T> T convertSendAndReceiveAsType​(java.lang.String exchange,
                                         java.lang.String routingKey,
                                         java.lang.Object message,
                                         @Nullable
                                         MessagePostProcessor messagePostProcessor,
                                         @Nullable
                                         CorrelationData correlationData,
                                         ParameterizedTypeReference<T> responseType)
                                  throws AmqpException
        Description copied from interface: RabbitOperations
        Basic RPC pattern with conversion. Send a Java object converted to a message to a specific exchange with a specific routing key and attempt to receive a response, converting that to a Java object. Implementations will normally set the reply-to header to an exclusive queue and wait up for some time limited by a timeout. Requires a SmartMessageConverter.
        Specified by:
        convertSendAndReceiveAsType in interface RabbitOperations
        Type Parameters:
        T - the type.
        Parameters:
        exchange - the name of the exchange
        routingKey - the routing key
        message - a message to send
        messagePostProcessor - a processor to apply to the message before it is sent
        correlationData - data to correlate publisher confirms.
        responseType - the type to convert the reply to.
        Returns:
        the response if there is one
        Throws:
        AmqpException - if there is a problem

      • convertSendAndReceiveRaw

        @Nullable
protected Message convertSendAndReceiveRaw​(java.lang.String exchange,
                                           java.lang.String routingKey,
                                           java.lang.Object message,
                                           @Nullable
                                           MessagePostProcessor messagePostProcessor,
                                           @Nullable
                                           CorrelationData correlationData)
        Convert and send a message and return the raw reply message, or null. Subclasses can invoke this method if they want to perform conversion on the outbound message but have direct access to the reply message before conversion.
        Parameters:
        exchange - the exchange.
        routingKey - the routing key.
        message - the data to send.
        messagePostProcessor - a message post processor (can be null).
        correlationData - correlation data (can be null).
        Returns:
        the reply message or null if a timeout occurs.
        Since:
        1.6.6

      • convertMessageIfNecessary

        protected Message convertMessageIfNecessary​(java.lang.Object object)

      • doSendAndReceive

        @Nullable
protected Message doSendAndReceive​(java.lang.String exchange,
                                   java.lang.String routingKey,
                                   Message message,
                                   @Nullable
                                   CorrelationData correlationData)
        Send a message and wait for a reply.
        Parameters:
        exchange - the exchange name
        routingKey - the routing key
        message - the message to send
        correlationData - the correlation data for confirms
        Returns:
        the message that is received in reply

      • replyTimedOut

        protected void replyTimedOut​(java.lang.String correlationId)
        Subclasses can implement this to be notified that a reply has timed out.
        Parameters:
        correlationId - the correlationId
        Since:
        2.1.2

      • isMandatoryFor

        public java.lang.Boolean isMandatoryFor​(Message message)
        Return whether the provided message should be sent with the mandatory flag set.
        Parameters:
        message - the message.
        Returns:
        true for mandatory.
        Since:
        2.0

      • invoke

        @Nullable
public <T> T invoke​(RabbitOperations.OperationsCallback<T> action,
                    @Nullable
                    com.rabbitmq.client.ConfirmCallback acks,
                    @Nullable
                    com.rabbitmq.client.ConfirmCallback nacks)
        Description copied from interface: RabbitOperations
        Invoke operations on the same channel. If callbacks are needed, both callbacks must be supplied.
        Specified by:
        invoke in interface RabbitOperations
        Type Parameters:
        T - the return type.
        Parameters:
        action - the callback.
        acks - a confirm callback for acks.
        nacks - a confirm callback for nacks.
        Returns:
        the result of the action method.

      • waitForConfirms

        public boolean waitForConfirms​(long timeout)
        Description copied from interface: RabbitOperations
        Delegate to the underlying dedicated channel to wait for confirms. The connection factory must be configured for publisher confirms and this method must be called within the scope of an RabbitOperations.invoke(OperationsCallback) operation. Requires CachingConnectionFactory#setPublisherConfirms(true).
        Specified by:
        waitForConfirms in interface RabbitOperations
        Parameters:
        timeout - the timeout
        Returns:
        true if acks and no nacks are received.
        See Also:
        Channel.waitForConfirms(long)

      • waitForConfirmsOrDie

        public void waitForConfirmsOrDie​(long timeout)
        Description copied from interface: RabbitOperations
        Delegate to the underlying dedicated channel to wait for confirms. The connection factory must be configured for publisher confirms and this method must be called within the scope of an RabbitOperations.invoke(OperationsCallback) operation. Requires CachingConnectionFactory#setPublisherConfirms(true).
        Specified by:
        waitForConfirmsOrDie in interface RabbitOperations
        Parameters:
        timeout - the timeout
        See Also:
        Channel.waitForConfirmsOrDie(long)

      • doSend

        public void doSend​(com.rabbitmq.client.Channel channel,
                   java.lang.String exchangeArg,
                   java.lang.String routingKeyArg,
                   Message message,
                   boolean mandatory,
                   @Nullable
                   CorrelationData correlationData)
            throws java.io.IOException
        Send the given message to the specified exchange.
        Parameters:
        channel - The RabbitMQ Channel to operate within.
        exchangeArg - The name of the RabbitMQ exchange to send to.
        routingKeyArg - The routing key.
        message - The Message to send.
        mandatory - The mandatory flag.
        correlationData - The correlation data.
        Throws:
        java.io.IOException - If thrown by RabbitMQ API methods.

      • nullSafeExchange

        public java.lang.String nullSafeExchange​(java.lang.String exchange)
        Return the exchange or the default exchange if null.
        Parameters:
        exchange - the exchange.
        Returns:
        the result.
        Since:
        2.3.4

      • nullSafeRoutingKey

        public java.lang.String nullSafeRoutingKey​(java.lang.String rk)
        Return the routing key or the default routing key if null.
        Parameters:
        rk - the routing key.
        Returns:
        the result.
        Since:
        2.3.4

      • sendToRabbit

        protected void sendToRabbit​(com.rabbitmq.client.Channel channel,
                            java.lang.String exchange,
                            java.lang.String routingKey,
                            boolean mandatory,
                            Message message)
                     throws java.io.IOException
        Throws:
        java.io.IOException

      • addListener

        public void addListener​(com.rabbitmq.client.Channel channel)
        Add this template as a confirms listener for the provided channel.
        Parameters:
        channel - the channel.
        Since:
        2.0

      • handleReturn

        public void handleReturn​(int replyCode,
                         java.lang.String replyText,
                         java.lang.String exchange,
                         java.lang.String routingKey,
                         com.rabbitmq.client.AMQP.BasicProperties properties,
                         byte[] body)
        Description copied from interface: PublisherCallbackChannel.Listener
        Handle a returned message.
        Specified by:
        handleReturn in interface PublisherCallbackChannel.Listener
        Parameters:
        replyCode - the reply code.
        replyText - the reply text.
        exchange - the exchange.
        routingKey - the routing key.
        properties - the message properties.
        body - the message body.

      • revoke

        public void revoke​(com.rabbitmq.client.Channel channel)
        Description copied from interface: PublisherCallbackChannel.Listener
        When called, this listener should remove all references to the channel - it will no longer be invoked by the channel.
        Specified by:
        revoke in interface PublisherCallbackChannel.Listener
        Parameters:
        channel - The channel.

      • onMessage

        public void onMessage​(Message message,
                      @Nullable
                      com.rabbitmq.client.Channel channel)
        Description copied from interface: ChannelAwareMessageListener
        Callback for processing a received Rabbit message.

        Implementors are supposed to process the given Message, typically sending reply messages through the given Session.

        Specified by:
        onMessage in interface ChannelAwareMessageListener
        Parameters:
        message - the received AMQP message (never null)
        channel - the underlying Rabbit Channel (never null unless called by the stream listener container).