public class RabbitTemplate extends RabbitAccessor implements org.springframework.beans.factory.BeanFactoryAware, RabbitOperations, MessageListener, ListenerContainerAware, PublisherCallbackChannel.Listener
Helper class that simplifies synchronous RabbitMQ access (sending and receiving messages).
The default settings are for non-transactional messaging, which reduces the amount of data exchanged with the broker.
To use a new transaction for every send or receive set the channelTransacted
flag. To extend the transaction over multiple invocations (more efficient), you can use a Spring transaction to
bracket the calls (with channelTransacted=true
as well).
The only mandatory property is the ConnectionFactory
. There are
strategies available for converting messages to and from Java objects (
MessageConverter
) and for converting message headers (known as message
properties in AMQP, see MessagePropertiesConverter
). The defaults probably do something sensible for typical use cases, as long as the message content-type is set
appropriately.
The "send" methods all have overloaded versions that allow you to explicitly target an exchange and a routing key, or you can set default values to be used in all send operations. The plain "receive" methods allow you to explicitly target a queue to receive from, or you can set a default value for the template that applies to all explicit receives. The convenience methods for send and receive use the sender defaults if no exchange or routing key is specified, but they always use a temporary queue for the receive leg, so the default queue is ignored.
Modifier and Type | Class and Description |
---|---|
static interface |
RabbitTemplate.ConfirmCallback |
static interface |
RabbitTemplate.ReturnCallback |
logger
Constructor and Description |
---|
RabbitTemplate()
Convenient constructor for use with setter injection.
|
RabbitTemplate(ConnectionFactory connectionFactory)
Create a rabbit template with default strategies and settings.
|
Modifier and Type | Method and Description |
---|---|
void |
convertAndSend(java.lang.Object object)
Convert a Java object to an Amqp
Message and send it to a default exchange with a default routing key. |
void |
convertAndSend(java.lang.Object message,
MessagePostProcessor messagePostProcessor)
Convert a Java object to an Amqp
Message and send it to a default exchange with a default routing key. |
void |
convertAndSend(java.lang.String routingKey,
java.lang.Object object)
Convert a Java object to an Amqp
Message and send it to a default exchange with a specific routing key. |
void |
convertAndSend(java.lang.String routingKey,
java.lang.Object object,
CorrelationData correlationData) |
void |
convertAndSend(java.lang.String routingKey,
java.lang.Object message,
MessagePostProcessor messagePostProcessor)
Convert a Java object to an Amqp
Message and send it to a default exchange with a specific routing key. |
void |
convertAndSend(java.lang.String routingKey,
java.lang.Object message,
MessagePostProcessor messagePostProcessor,
CorrelationData correlationData) |
void |
convertAndSend(java.lang.String exchange,
java.lang.String routingKey,
java.lang.Object object)
Convert a Java object to an Amqp
Message and send it to a specific exchange with a specific routing key. |
void |
convertAndSend(java.lang.String exchange,
java.lang.String routingKey,
java.lang.Object object,
CorrelationData correlationData) |
void |
convertAndSend(java.lang.String exchange,
java.lang.String routingKey,
java.lang.Object message,
MessagePostProcessor messagePostProcessor)
Convert a Java object to an Amqp
Message and send it to a specific exchange with a specific routing key. |
void |
convertAndSend(java.lang.String exchange,
java.lang.String routingKey,
java.lang.Object message,
MessagePostProcessor messagePostProcessor,
CorrelationData correlationData) |
protected Message |
convertMessageIfNecessary(java.lang.Object object) |
java.lang.Object |
convertSendAndReceive(java.lang.Object message)
Basic RPC pattern with conversion.
|
java.lang.Object |
convertSendAndReceive(java.lang.Object message,
CorrelationData correlationData) |
java.lang.Object |
convertSendAndReceive(java.lang.Object message,
MessagePostProcessor messagePostProcessor)
Basic RPC pattern with conversion.
|
java.lang.Object |
convertSendAndReceive(java.lang.Object message,
MessagePostProcessor messagePostProcessor,
CorrelationData correlationData) |
java.lang.Object |
convertSendAndReceive(java.lang.String routingKey,
java.lang.Object message)
Basic RPC pattern with conversion.
|
java.lang.Object |
convertSendAndReceive(java.lang.String routingKey,
java.lang.Object message,
CorrelationData correlationData) |
java.lang.Object |
convertSendAndReceive(java.lang.String routingKey,
java.lang.Object message,
MessagePostProcessor messagePostProcessor)
Basic RPC pattern with conversion.
|
java.lang.Object |
convertSendAndReceive(java.lang.String routingKey,
java.lang.Object message,
MessagePostProcessor messagePostProcessor,
CorrelationData correlationData) |
java.lang.Object |
convertSendAndReceive(java.lang.String exchange,
java.lang.String routingKey,
java.lang.Object message)
Basic RPC pattern with conversion.
|
java.lang.Object |
convertSendAndReceive(java.lang.String exchange,
java.lang.String routingKey,
java.lang.Object message,
CorrelationData correlationData) |
java.lang.Object |
convertSendAndReceive(java.lang.String exchange,
java.lang.String routingKey,
java.lang.Object message,
MessagePostProcessor messagePostProcessor)
Basic RPC pattern with conversion.
|
java.lang.Object |
convertSendAndReceive(java.lang.String exchange,
java.lang.String routingKey,
java.lang.Object message,
MessagePostProcessor messagePostProcessor,
CorrelationData correlationData) |
protected Message |
convertSendAndReceiveRaw(java.lang.String exchange,
java.lang.String routingKey,
java.lang.Object message,
MessagePostProcessor messagePostProcessor,
CorrelationData correlationData)
Convert and send a message and return the raw reply message, or null.
|
void |
correlationconvertAndSend(java.lang.Object object,
CorrelationData correlationData)
Deprecated.
|
void |
correlationConvertAndSend(java.lang.Object object,
CorrelationData correlationData) |
void |
determineConfirmsReturnsCapability(ConnectionFactory connectionFactory) |
protected Message |
doReceiveNoWait(java.lang.String queueName)
Non-blocking receive.
|
protected void |
doSend(com.rabbitmq.client.Channel channel,
java.lang.String exchange,
java.lang.String routingKey,
Message message,
boolean mandatory,
CorrelationData correlationData)
Send the given message to the specified exchange.
|
protected Message |
doSendAndReceive(java.lang.String exchange,
java.lang.String routingKey,
Message message,
CorrelationData correlationData)
Send a message and wait for a reply.
|
protected Message |
doSendAndReceiveWithFixed(java.lang.String exchange,
java.lang.String routingKey,
Message message,
CorrelationData correlationData) |
protected Message |
doSendAndReceiveWithTemporary(java.lang.String exchange,
java.lang.String routingKey,
Message message,
CorrelationData correlationData) |
<T> T |
execute(ChannelCallback<T> action) |
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.
|
java.lang.String |
getExchange() |
MessageConverter |
getMessageConverter()
Return the message converter for this template.
|
java.lang.String |
getRoutingKey() |
java.util.Collection<CorrelationData> |
getUnconfirmed(long age)
Gets unconfirmed correlation data older than age and removes them.
|
java.lang.String |
getUUID()
Returns the UUID used to identify this Listener for returns.
|
void |
handleConfirm(PendingConfirm pendingConfirm,
boolean ack)
Invoked by the channel when a confirm is received.
|
void |
handleReturn(int replyCode,
java.lang.String replyText,
java.lang.String exchange,
java.lang.String routingKey,
com.rabbitmq.client.AMQP.BasicProperties properties,
byte[] body) |
protected void |
initDefaultStrategies()
Set up the default strategies.
|
protected boolean |
isChannelLocallyTransacted(com.rabbitmq.client.Channel channel)
Check whether the given Channel is locally transacted, that is, whether its transaction is managed by this
template's Channel handling and not by an external transaction coordinator.
|
boolean |
isConfirmListener() |
boolean |
isReturnListener() |
void |
onMessage(Message message) |
Message |
receive()
Receive a message if there is one from a default queue.
|
Message |
receive(long timeoutMillis)
Receive a message from a default queue, waiting up to the specified wait time if necessary for a message
to become available.
|
Message |
receive(java.lang.String queueName)
Receive a message if there is one from a specific queue.
|
Message |
receive(java.lang.String queueName,
long timeoutMillis)
Receive a message from a specific queue, waiting up to the specified wait time if necessary for a message
to become available.
|
java.lang.Object |
receiveAndConvert()
Receive a message if there is one from a default queue and convert it to a Java object.
|
java.lang.Object |
receiveAndConvert(long timeoutMillis)
Receive a message if there is one from a default queue and convert it to a Java object.
|
java.lang.Object |
receiveAndConvert(java.lang.String queueName)
Receive a message if there is one from a specific queue and convert it to a Java object.
|
java.lang.Object |
receiveAndConvert(java.lang.String queueName,
long timeoutMillis)
Receive a message if there is one from a specific queue and convert it to a Java object.
|
<R,S> boolean |
receiveAndReply(ReceiveAndReplyCallback<R,S> callback)
Receive a message if there is one from a default 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. |
<R,S> boolean |
receiveAndReply(ReceiveAndReplyCallback<R,S> callback,
ReplyToAddressCallback<S> replyToAddressCallback)
Receive a message if there is one from a default queue, invoke provided
ReceiveAndReplyCallback
and send reply message, if the callback returns one,
to the replyTo Address
from result of ReplyToAddressCallback . |
<R,S> boolean |
receiveAndReply(ReceiveAndReplyCallback<R,S> callback,
java.lang.String exchange,
java.lang.String routingKey)
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 . |
<R,S> boolean |
receiveAndReply(java.lang.String queueName,
ReceiveAndReplyCallback<R,S> callback)
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. |
<R,S> boolean |
receiveAndReply(java.lang.String queueName,
ReceiveAndReplyCallback<R,S> callback,
ReplyToAddressCallback<S> replyToAddressCallback)
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 . |
<R,S> boolean |
receiveAndReply(java.lang.String queueName,
ReceiveAndReplyCallback<R,S> callback,
java.lang.String replyExchange,
java.lang.String replyRoutingKey)
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 . |
void |
revoke(com.rabbitmq.client.Channel channel)
When called, this listener should remove all references to the
channel - it will no longer be invoked by the channel.
|
void |
send(Message message)
Send a message to a default exchange with a default routing key.
|
void |
send(java.lang.String routingKey,
Message message)
Send a message to a default exchange with a specific routing key.
|
void |
send(java.lang.String exchange,
java.lang.String routingKey,
Message message)
Send a message to a specific exchange with a specific routing key.
|
void |
send(java.lang.String exchange,
java.lang.String routingKey,
Message message,
CorrelationData correlationData) |
Message |
sendAndReceive(Message message)
Basic RPC pattern.
|
Message |
sendAndReceive(Message message,
CorrelationData correlationData) |
Message |
sendAndReceive(java.lang.String routingKey,
Message message)
Basic RPC pattern.
|
Message |
sendAndReceive(java.lang.String routingKey,
Message message,
CorrelationData correlationData) |
Message |
sendAndReceive(java.lang.String exchange,
java.lang.String routingKey,
Message message)
Basic RPC pattern.
|
Message |
sendAndReceive(java.lang.String exchange,
java.lang.String routingKey,
Message message,
CorrelationData correlationData) |
void |
setAfterReceivePostProcessor(MessagePostProcessor... afterReceivePostProcessors)
Deprecated.
|
void |
setAfterReceivePostProcessors(MessagePostProcessor... afterReceivePostProcessors)
Set a
MessagePostProcessor that will be invoked immediately after a Channel#basicGet()
and before any message conversion is performed. |
void |
setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory) |
void |
setBeforePublishPostProcessors(MessagePostProcessor... beforePublishPostProcessors)
Set
MessagePostProcessor s that will be invoked immediately before invoking
Channel#basicPublish() , after all other processing, except creating the
AMQP.BasicProperties from MessageProperties . |
void |
setConfirmCallback(RabbitTemplate.ConfirmCallback confirmCallback) |
void |
setCorrelationDataPostProcessor(CorrelationDataPostProcessor correlationDataPostProcessor)
Set a
CorrelationDataPostProcessor to be invoked before publishing a message. |
void |
setCorrelationKey(java.lang.String correlationKey)
If set to 'correlationId' (default) the correlationId property
will be used; otherwise the supplied key will be used.
|
void |
setEncoding(java.lang.String encoding)
The encoding to use when inter-converting between byte arrays and Strings in message properties.
|
void |
setExchange(java.lang.String exchange)
The name of the default exchange to use for send operations when none is specified.
|
void |
setMandatory(boolean mandatory) |
void |
setMandatoryExpression(org.springframework.expression.Expression mandatoryExpression) |
void |
setMessageConverter(MessageConverter messageConverter)
Set the message converter for this template.
|
void |
setMessagePropertiesConverter(MessagePropertiesConverter messagePropertiesConverter)
Set the
MessagePropertiesConverter for this template. |
void |
setQueue(java.lang.String queue)
The name of the default queue to receive messages from when none is specified explicitly.
|
void |
setReceiveConnectionFactorySelectorExpression(org.springframework.expression.Expression receiveConnectionFactorySelectorExpression)
A SpEL
Expression to evaluate
against each receive queueName , if the provided RabbitAccessor.getConnectionFactory()
is an instance of AbstractRoutingConnectionFactory . |
void |
setReceiveTimeout(long receiveTimeout)
Specify the receive timeout in milliseconds when using
receive() methods (for sendAndReceive()
methods, refer to replyTimeout . |
void |
setRecoveryCallback(org.springframework.retry.RecoveryCallback<?> recoveryCallback)
Add a
RecoveryCallback which is used for the retryTemplate.execute . |
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
http://www.rabbitmq.com/direct-reply-to.html
|
void |
setReplyQueue(Queue replyQueue)
Deprecated.
- use #setReplyAddress(String replyAddress)
|
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.
|
void |
setRetryTemplate(org.springframework.retry.support.RetryTemplate retryTemplate)
Add a
RetryTemplate which will be used for all rabbit operations. |
void |
setReturnCallback(RabbitTemplate.ReturnCallback returnCallback) |
void |
setRoutingKey(java.lang.String routingKey)
The value of a default routing key to use for send operations when none is specified.
|
void |
setSendConnectionFactorySelectorExpression(org.springframework.expression.Expression sendConnectionFactorySelectorExpression)
A SpEL
Expression to evaluate
against each request message, if the provided RabbitAccessor.getConnectionFactory()
is an instance of AbstractRoutingConnectionFactory . |
void |
setUserIdExpression(org.springframework.expression.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.
|
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.
|
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). |
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).
|
afterPropertiesSet, convertRabbitAccessException, createConnection, getChannel, getConnection, getConnectionFactory, getTransactionalResourceHolder, isChannelTransacted, setChannelTransacted, setConnectionFactory
public RabbitTemplate()
public RabbitTemplate(ConnectionFactory connectionFactory)
connectionFactory
- the connection factory to useprotected void initDefaultStrategies()
public void setExchange(java.lang.String exchange)
""
which is the default exchange in the broker (per the AMQP specification).exchange
- the exchange name to use for send operationspublic java.lang.String getExchange()
public void setRoutingKey(java.lang.String routingKey)
routingKey
- the default routing key to use for send operationspublic java.lang.String getRoutingKey()
public void setQueue(java.lang.String queue)
queue
- the default queue name to use for receivepublic void setEncoding(java.lang.String encoding)
encoding
- the encoding to set@Deprecated public void setReplyQueue(Queue replyQueue)
replyQueue
- the replyQueue to setpublic void setReplyAddress(java.lang.String replyAddress)
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.
replyAddress
- the replyAddress to setpublic void setReceiveTimeout(long receiveTimeout)
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.receiveTimeout
- the timeout.public void setReplyTimeout(long replyTimeout)
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.replyTimeout
- the reply timeout in millisecondssendAndReceive(String, String, Message)
,
convertSendAndReceive(String, String, Object)
public void setMessageConverter(MessageConverter messageConverter)
The default converter is a SimpleMessageConverter, which is able to handle byte arrays, Strings, and Serializable Objects depending on the message content type header.
messageConverter
- The message converter.convertAndSend(java.lang.Object)
,
receiveAndConvert()
,
SimpleMessageConverter
public void setMessagePropertiesConverter(MessagePropertiesConverter messagePropertiesConverter)
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.messagePropertiesConverter
- The message properties converter.public MessageConverter getMessageConverter()
ChannelCallback
implementations.public void setConfirmCallback(RabbitTemplate.ConfirmCallback confirmCallback)
public void setReturnCallback(RabbitTemplate.ReturnCallback returnCallback)
public void setMandatory(boolean mandatory)
public void setMandatoryExpression(org.springframework.expression.Expression mandatoryExpression)
mandatoryExpression
- a SpEL Expression
to evaluate against each request
message, if a returnCallback
has been provided. The result of expression must be
a boolean
value.public void setSendConnectionFactorySelectorExpression(org.springframework.expression.Expression sendConnectionFactorySelectorExpression)
Expression
to evaluate
against each request message, if the provided RabbitAccessor.getConnectionFactory()
is an instance of AbstractRoutingConnectionFactory
.
The result of this expression is used as lookupKey
to get the target
ConnectionFactory
from AbstractRoutingConnectionFactory
directly.
If this expression is evaluated to null
, we fallback to the normal
AbstractRoutingConnectionFactory
logic.
If there is no target ConnectionFactory
with the evaluated lookupKey
,
we fallback to the normal AbstractRoutingConnectionFactory
logic
only if its property lenientFallback == true
.
This expression is used for send
operations.
sendConnectionFactorySelectorExpression
- a SpEL Expression
to evaluatepublic void setReceiveConnectionFactorySelectorExpression(org.springframework.expression.Expression receiveConnectionFactorySelectorExpression)
Expression
to evaluate
against each receive
queueName
, if the provided RabbitAccessor.getConnectionFactory()
is an instance of AbstractRoutingConnectionFactory
.
The result of this expression is used as lookupKey
to get the target
ConnectionFactory
from AbstractRoutingConnectionFactory
directly.
If this expression is evaluated to null
, we fallback to the normal
AbstractRoutingConnectionFactory
logic.
If there is no target ConnectionFactory
with the evaluated lookupKey
,
we fallback to the normal AbstractRoutingConnectionFactory
logic
only if its property lenientFallback == true
.
This expression is used for receive
operations.
receiveConnectionFactorySelectorExpression
- a SpEL Expression
to evaluatepublic void setCorrelationKey(java.lang.String correlationKey)
correlationKey
- the correlationKey to setpublic void setRetryTemplate(org.springframework.retry.support.RetryTemplate retryTemplate)
RetryTemplate
which will be used for all rabbit operations.retryTemplate
- The retry template.public void setRecoveryCallback(org.springframework.retry.RecoveryCallback<?> recoveryCallback)
RecoveryCallback
which is used for the retryTemplate.execute
.
If retryTemplate
isn't provided recoveryCallback
is ignored.
RecoveryCallback
should produce result compatible with
execute(ChannelCallback, ConnectionFactory)
return type.recoveryCallback
- The retry recoveryCallback.public void setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory) throws org.springframework.beans.BeansException
setBeanFactory
in interface org.springframework.beans.factory.BeanFactoryAware
org.springframework.beans.BeansException
public void setBeforePublishPostProcessors(MessagePostProcessor... beforePublishPostProcessors)
MessagePostProcessor
s 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.beforePublishPostProcessors
- the post processor.@Deprecated public void setAfterReceivePostProcessor(MessagePostProcessor... afterReceivePostProcessors)
setAfterReceivePostProcessors(MessagePostProcessor...)
afterReceivePostProcessors
- the post processors.public void setAfterReceivePostProcessors(MessagePostProcessor... afterReceivePostProcessors)
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.afterReceivePostProcessors
- the post processor.public void setCorrelationDataPostProcessor(CorrelationDataPostProcessor correlationDataPostProcessor)
CorrelationDataPostProcessor
to be invoked before publishing a message.
Correlation data is used to correlate publisher confirms.correlationDataPostProcessor
- the post processor.setConfirmCallback(ConfirmCallback)
public void setUseTemporaryReplyQueues(boolean value)
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.value
- true to use temporary queues.public void setUserIdExpression(org.springframework.expression.Expression userIdExpression)
userIdExpression
- the expression.public void setUserIdExpressionString(java.lang.String userIdExpression)
userIdExpression
- the expression.public java.util.Collection<java.lang.String> expectedQueueNames()
expectedQueueNames
in interface ListenerContainerAware
public java.util.Collection<CorrelationData> getUnconfirmed(long age)
age
- in millisecondsprotected boolean useDirectReplyTo()
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.
public void send(Message message) throws AmqpException
AmqpTemplate
send
in interface AmqpTemplate
message
- a message to sendAmqpException
- if there is a problempublic void send(java.lang.String routingKey, Message message) throws AmqpException
AmqpTemplate
send
in interface AmqpTemplate
routingKey
- the routing keymessage
- a message to sendAmqpException
- if there is a problempublic void send(java.lang.String exchange, java.lang.String routingKey, Message message) throws AmqpException
AmqpTemplate
send
in interface AmqpTemplate
exchange
- the name of the exchangeroutingKey
- the routing keymessage
- a message to sendAmqpException
- if there is a problempublic void send(java.lang.String exchange, java.lang.String routingKey, Message message, CorrelationData correlationData) throws AmqpException
AmqpException
public void convertAndSend(java.lang.Object object) throws AmqpException
AmqpTemplate
Message
and send it to a default exchange with a default routing key.convertAndSend
in interface AmqpTemplate
object
- a message to sendAmqpException
- if there is a problem@Deprecated public void correlationconvertAndSend(java.lang.Object object, CorrelationData correlationData) throws AmqpException
AmqpException
public void correlationConvertAndSend(java.lang.Object object, CorrelationData correlationData) throws AmqpException
AmqpException
public void convertAndSend(java.lang.String routingKey, java.lang.Object object) throws AmqpException
AmqpTemplate
Message
and send it to a default exchange with a specific routing key.convertAndSend
in interface AmqpTemplate
routingKey
- the routing keyobject
- a message to sendAmqpException
- if there is a problempublic void convertAndSend(java.lang.String routingKey, java.lang.Object object, CorrelationData correlationData) throws AmqpException
AmqpException
public void convertAndSend(java.lang.String exchange, java.lang.String routingKey, java.lang.Object object) throws AmqpException
AmqpTemplate
Message
and send it to a specific exchange with a specific routing key.convertAndSend
in interface AmqpTemplate
exchange
- the name of the exchangeroutingKey
- the routing keyobject
- a message to sendAmqpException
- if there is a problempublic void convertAndSend(java.lang.String exchange, java.lang.String routingKey, java.lang.Object object, CorrelationData correlationData) throws AmqpException
AmqpException
public void convertAndSend(java.lang.Object message, MessagePostProcessor messagePostProcessor) throws AmqpException
AmqpTemplate
Message
and send it to a default exchange with a default routing key.convertAndSend
in interface AmqpTemplate
message
- a message to sendmessagePostProcessor
- a processor to apply to the message before it is sentAmqpException
- if there is a problempublic void convertAndSend(java.lang.String routingKey, java.lang.Object message, MessagePostProcessor messagePostProcessor) throws AmqpException
AmqpTemplate
Message
and send it to a default exchange with a specific routing key.convertAndSend
in interface AmqpTemplate
routingKey
- the routing keymessage
- a message to sendmessagePostProcessor
- a processor to apply to the message before it is sentAmqpException
- if there is a problempublic void convertAndSend(java.lang.String routingKey, java.lang.Object message, MessagePostProcessor messagePostProcessor, CorrelationData correlationData) throws AmqpException
AmqpException
public void convertAndSend(java.lang.String exchange, java.lang.String routingKey, java.lang.Object message, MessagePostProcessor messagePostProcessor) throws AmqpException
AmqpTemplate
Message
and send it to a specific exchange with a specific routing key.convertAndSend
in interface AmqpTemplate
exchange
- the name of the exchangeroutingKey
- the routing keymessage
- a message to sendmessagePostProcessor
- a processor to apply to the message before it is sentAmqpException
- if there is a problempublic void convertAndSend(java.lang.String exchange, java.lang.String routingKey, java.lang.Object message, MessagePostProcessor messagePostProcessor, CorrelationData correlationData) throws AmqpException
AmqpException
public Message receive() throws AmqpException
AmqpTemplate
receive
in interface AmqpTemplate
AmqpException
- if there is a problempublic Message receive(java.lang.String queueName)
AmqpTemplate
receive
in interface AmqpTemplate
queueName
- the name of the queue to pollprotected Message doReceiveNoWait(java.lang.String queueName)
queueName
- the queue to receive from.public Message receive(long timeoutMillis) throws AmqpException
AmqpTemplate
receive
in interface AmqpTemplate
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.AmqpException
- if there is a problempublic Message receive(java.lang.String queueName, long timeoutMillis)
AmqpTemplate
receive
in interface AmqpTemplate
queueName
- the queue to receive fromtimeoutMillis
- 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.public java.lang.Object receiveAndConvert() throws AmqpException
AmqpTemplate
receiveAndConvert
in interface AmqpTemplate
AmqpException
- if there is a problempublic java.lang.Object receiveAndConvert(java.lang.String queueName) throws AmqpException
AmqpTemplate
receiveAndConvert
in interface AmqpTemplate
queueName
- the name of the queue to pollAmqpException
- if there is a problempublic java.lang.Object receiveAndConvert(long timeoutMillis) throws AmqpException
AmqpTemplate
receiveAndConvert
in interface AmqpTemplate
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.AmqpException
- if there is a problempublic java.lang.Object receiveAndConvert(java.lang.String queueName, long timeoutMillis) throws AmqpException
AmqpTemplate
receiveAndConvert
in interface AmqpTemplate
queueName
- the name of the queue to polltimeoutMillis
- 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.AmqpException
- if there is a problempublic <R,S> boolean receiveAndReply(ReceiveAndReplyCallback<R,S> callback) throws AmqpException
AmqpTemplate
ReceiveAndReplyCallback
and send reply message, if the callback
returns one,
to the replyTo
Address
from MessageProperties
or to default exchange and default routingKey.receiveAndReply
in interface AmqpTemplate
R
- The type of the request after conversion from the Message
.S
- The type of the response.callback
- a user-provided ReceiveAndReplyCallback
implementation to process received message
and return a reply message.true
, if message was receivedAmqpException
- if there is a problempublic <R,S> boolean receiveAndReply(java.lang.String queueName, ReceiveAndReplyCallback<R,S> callback) throws AmqpException
AmqpTemplate
ReceiveAndReplyCallback
and send reply message, if the callback
returns one,
to the replyTo
Address
from MessageProperties
or to default exchange and default routingKey.receiveAndReply
in interface AmqpTemplate
R
- The type of the request after conversion from the Message
.S
- The type of the response.queueName
- the queue name to receive a message.callback
- a user-provided ReceiveAndReplyCallback
implementation to process received message
and return a reply message.true
, if message was received.AmqpException
- if there is a problem.public <R,S> boolean receiveAndReply(ReceiveAndReplyCallback<R,S> callback, java.lang.String exchange, java.lang.String routingKey) throws AmqpException
AmqpTemplate
ReceiveAndReplyCallback
and send reply message, if the callback
returns one,
to the provided exchange
and routingKey
.receiveAndReply
in interface AmqpTemplate
R
- The type of the request after conversion from the Message
.S
- The type of the response.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.true
, if message was received.AmqpException
- if there is a problem.public <R,S> boolean receiveAndReply(java.lang.String queueName, ReceiveAndReplyCallback<R,S> callback, java.lang.String replyExchange, java.lang.String replyRoutingKey) throws AmqpException
AmqpTemplate
ReceiveAndReplyCallback
and send reply message, if the callback
returns one,
to the provided exchange
and routingKey
.receiveAndReply
in interface AmqpTemplate
R
- The type of the request after conversion from the Message
.S
- The type of the response.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.true
, if message was receivedAmqpException
- if there is a problempublic <R,S> boolean receiveAndReply(ReceiveAndReplyCallback<R,S> callback, ReplyToAddressCallback<S> replyToAddressCallback) throws AmqpException
AmqpTemplate
ReceiveAndReplyCallback
and send reply message, if the callback
returns one,
to the replyTo
Address
from result of ReplyToAddressCallback
.receiveAndReply
in interface AmqpTemplate
R
- The type of the request after conversion from the Message
.S
- The type of the response.callback
- a user-provided ReceiveAndReplyCallback
implementation to process received message
and return a reply message.replyToAddressCallback
- the callback to determine replyTo address at runtime.true
, if message was received.AmqpException
- if there is a problem.public <R,S> boolean receiveAndReply(java.lang.String queueName, ReceiveAndReplyCallback<R,S> callback, ReplyToAddressCallback<S> replyToAddressCallback) throws AmqpException
AmqpTemplate
ReceiveAndReplyCallback
and send reply message, if the callback
returns one,
to the replyTo
Address
from result of ReplyToAddressCallback
.receiveAndReply
in interface AmqpTemplate
R
- The type of the request after conversion from the Message
.S
- The type of the response.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.true
, if message was receivedAmqpException
- if there is a problempublic Message sendAndReceive(Message message) throws AmqpException
AmqpTemplate
sendAndReceive
in interface AmqpTemplate
message
- a message to sendAmqpException
- if there is a problempublic Message sendAndReceive(Message message, CorrelationData correlationData) throws AmqpException
AmqpException
public Message sendAndReceive(java.lang.String routingKey, Message message) throws AmqpException
AmqpTemplate
sendAndReceive
in interface AmqpTemplate
routingKey
- the routing keymessage
- a message to sendAmqpException
- if there is a problempublic Message sendAndReceive(java.lang.String routingKey, Message message, CorrelationData correlationData) throws AmqpException
AmqpException
public Message sendAndReceive(java.lang.String exchange, java.lang.String routingKey, Message message) throws AmqpException
AmqpTemplate
sendAndReceive
in interface AmqpTemplate
exchange
- the name of the exchangeroutingKey
- the routing keymessage
- a message to sendAmqpException
- if there is a problempublic Message sendAndReceive(java.lang.String exchange, java.lang.String routingKey, Message message, CorrelationData correlationData) throws AmqpException
AmqpException
public java.lang.Object convertSendAndReceive(java.lang.Object message) throws AmqpException
AmqpTemplate
convertSendAndReceive
in interface AmqpTemplate
message
- a message to sendAmqpException
- if there is a problempublic java.lang.Object convertSendAndReceive(java.lang.Object message, CorrelationData correlationData) throws AmqpException
AmqpException
public java.lang.Object convertSendAndReceive(java.lang.String routingKey, java.lang.Object message) throws AmqpException
AmqpTemplate
convertSendAndReceive
in interface AmqpTemplate
routingKey
- the routing keymessage
- a message to sendAmqpException
- if there is a problempublic java.lang.Object convertSendAndReceive(java.lang.String routingKey, java.lang.Object message, CorrelationData correlationData) throws AmqpException
AmqpException
public java.lang.Object convertSendAndReceive(java.lang.String exchange, java.lang.String routingKey, java.lang.Object message) throws AmqpException
AmqpTemplate
convertSendAndReceive
in interface AmqpTemplate
exchange
- the name of the exchangeroutingKey
- the routing keymessage
- a message to sendAmqpException
- if there is a problempublic java.lang.Object convertSendAndReceive(java.lang.String exchange, java.lang.String routingKey, java.lang.Object message, CorrelationData correlationData) throws AmqpException
AmqpException
public java.lang.Object convertSendAndReceive(java.lang.Object message, MessagePostProcessor messagePostProcessor) throws AmqpException
AmqpTemplate
convertSendAndReceive
in interface AmqpTemplate
message
- a message to sendmessagePostProcessor
- a processor to apply to the message before it is sentAmqpException
- if there is a problempublic java.lang.Object convertSendAndReceive(java.lang.Object message, MessagePostProcessor messagePostProcessor, CorrelationData correlationData) throws AmqpException
AmqpException
public java.lang.Object convertSendAndReceive(java.lang.String routingKey, java.lang.Object message, MessagePostProcessor messagePostProcessor) throws AmqpException
AmqpTemplate
convertSendAndReceive
in interface AmqpTemplate
routingKey
- the routing keymessage
- a message to sendmessagePostProcessor
- a processor to apply to the message before it is sentAmqpException
- if there is a problempublic java.lang.Object convertSendAndReceive(java.lang.String routingKey, java.lang.Object message, MessagePostProcessor messagePostProcessor, CorrelationData correlationData) throws AmqpException
AmqpException
public java.lang.Object convertSendAndReceive(java.lang.String exchange, java.lang.String routingKey, java.lang.Object message, MessagePostProcessor messagePostProcessor) throws AmqpException
AmqpTemplate
convertSendAndReceive
in interface AmqpTemplate
exchange
- the name of the exchangeroutingKey
- the routing keymessage
- a message to sendmessagePostProcessor
- a processor to apply to the message before it is sentAmqpException
- if there is a problempublic java.lang.Object convertSendAndReceive(java.lang.String exchange, java.lang.String routingKey, java.lang.Object message, MessagePostProcessor messagePostProcessor, CorrelationData correlationData) throws AmqpException
AmqpException
protected Message convertSendAndReceiveRaw(java.lang.String exchange, java.lang.String routingKey, java.lang.Object message, MessagePostProcessor messagePostProcessor, CorrelationData correlationData)
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).protected Message convertMessageIfNecessary(java.lang.Object object)
protected Message doSendAndReceive(java.lang.String exchange, java.lang.String routingKey, Message message, CorrelationData correlationData)
exchange
- the exchange nameroutingKey
- the routing keymessage
- the message to sendcorrelationData
- the correlation data for confirmsprotected Message doSendAndReceiveWithTemporary(java.lang.String exchange, java.lang.String routingKey, Message message, CorrelationData correlationData)
protected Message doSendAndReceiveWithFixed(java.lang.String exchange, java.lang.String routingKey, Message message, CorrelationData correlationData)
public <T> T execute(ChannelCallback<T> action)
execute
in interface RabbitOperations
public void determineConfirmsReturnsCapability(ConnectionFactory connectionFactory)
protected void doSend(com.rabbitmq.client.Channel channel, java.lang.String exchange, java.lang.String routingKey, Message message, boolean mandatory, CorrelationData correlationData) throws java.lang.Exception
channel
- The RabbitMQ Channel to operate within.exchange
- The name of the RabbitMQ exchange to send to.routingKey
- The routing key.message
- The Message to send.mandatory
- The mandatory flag.correlationData
- The correlation data.java.io.IOException
- If thrown by RabbitMQ API methodsjava.lang.Exception
protected boolean isChannelLocallyTransacted(com.rabbitmq.client.Channel channel)
channel
- the Channel to checkConnectionFactoryUtils.isChannelTransactional(com.rabbitmq.client.Channel, org.springframework.amqp.rabbit.connection.ConnectionFactory)
,
RabbitAccessor.isChannelTransacted()
public void handleConfirm(PendingConfirm pendingConfirm, boolean ack)
PublisherCallbackChannel.Listener
handleConfirm
in interface PublisherCallbackChannel.Listener
pendingConfirm
- The pending confirmation, containing
correlation data.ack
- true when 'ack', false when 'nack'.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) throws java.io.IOException
handleReturn
in interface PublisherCallbackChannel.Listener
java.io.IOException
public boolean isConfirmListener()
isConfirmListener
in interface PublisherCallbackChannel.Listener
public boolean isReturnListener()
isReturnListener
in interface PublisherCallbackChannel.Listener
public void revoke(com.rabbitmq.client.Channel channel)
PublisherCallbackChannel.Listener
revoke
in interface PublisherCallbackChannel.Listener
channel
- The channel.public java.lang.String getUUID()
PublisherCallbackChannel.Listener
getUUID
in interface PublisherCallbackChannel.Listener
public void onMessage(Message message)
onMessage
in interface MessageListener