org.springframework.amqp.rabbit.core
Class RabbitTemplate

java.lang.Object
  org.springframework.amqp.rabbit.connection.RabbitAccessor
      org.springframework.amqp.rabbit.core.RabbitTemplate

All Implemented Interfaces:

AmqpTemplate, RabbitOperations, org.springframework.beans.factory.InitializingBean

public class RabbitTemplate
extends RabbitAccessor
implements RabbitOperations

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.

Since:

1.0

Author:

Mark Pollack, Mark Fisher, Dave Syer

Field Summary

Fields inherited from class org.springframework.amqp.rabbit.connection.RabbitAccessor

logger

Constructor Summary

RabbitTemplate()
Convenient constructor for use with setter injection.

RabbitTemplate(ConnectionFactory connectionFactory)
Create a rabbit template with default strategies and settings.

Method Summary

void	convertAndSend(java.lang.Object object)
void	convertAndSend(java.lang.Object message, MessagePostProcessor messagePostProcessor)
void	convertAndSend(java.lang.String routingKey, java.lang.Object object)
void	convertAndSend(java.lang.String routingKey, java.lang.Object message, MessagePostProcessor messagePostProcessor)
void	convertAndSend(java.lang.String exchange, java.lang.String routingKey, java.lang.Object object)
void	convertAndSend(java.lang.String exchange, java.lang.String routingKey, java.lang.Object message, MessagePostProcessor messagePostProcessor)
java.lang.Object	convertSendAndReceive(java.lang.Object message)
java.lang.Object	convertSendAndReceive(java.lang.Object message, MessagePostProcessor messagePostProcessor)
java.lang.Object	convertSendAndReceive(java.lang.String routingKey, java.lang.Object message)
java.lang.Object	convertSendAndReceive(java.lang.String routingKey, java.lang.Object message, MessagePostProcessor messagePostProcessor)
java.lang.Object	convertSendAndReceive(java.lang.String exchange, java.lang.String routingKey, java.lang.Object message)
java.lang.Object	convertSendAndReceive(java.lang.String exchange, java.lang.String routingKey, java.lang.Object message, MessagePostProcessor messagePostProcessor)
protected void	doSend(com.rabbitmq.client.Channel channel, java.lang.String exchange, java.lang.String routingKey, Message message) Send the given message to the specified exchange.
protected Message	doSendAndReceive(java.lang.String exchange, java.lang.String routingKey, Message message) Send a message and wait for a reply.
<T> T	execute(ChannelCallback<T> action)
MessageConverter	getMessageConverter() Return the message converter for this template.
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.
Message	receive()
Message	receive(java.lang.String queueName)
java.lang.Object	receiveAndConvert()
java.lang.Object	receiveAndConvert(java.lang.String queueName)
void	send(Message message)
void	send(java.lang.String routingKey, Message message)
void	send(java.lang.String exchange, java.lang.String routingKey, Message message)
Message	sendAndReceive(Message message)
Message	sendAndReceive(java.lang.String routingKey, Message message)
Message	sendAndReceive(java.lang.String exchange, java.lang.String routingKey, Message message)
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	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	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	setRoutingKey(java.lang.String routingKey) The value of a default routing key to use for send operations when none is specified.

Methods inherited from class org.springframework.amqp.rabbit.connection.RabbitAccessor

afterPropertiesSet, convertRabbitAccessException, createConnection, getChannel, getConnection, getConnectionFactory, getTransactionalResourceHolder, isChannelTransacted, setChannelTransacted, setConnectionFactory

Methods inherited from class java.lang.Object

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

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(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

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:

exchange - the default routing key to use for send operations

setQueue

public void setQueue(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

setEncoding

public void setEncoding(java.lang.String encoding)

The encoding to use when inter-converting between byte arrays and Strings in message properties.

Parameters:

encoding - the encoding to set

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.

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.

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.

send

public void send(Message message)
          throws AmqpException

Specified by:

send in interface AmqpTemplate

Throws:

AmqpException

send

public void send(java.lang.String routingKey,
                 Message message)
          throws AmqpException

Specified by:

send in interface AmqpTemplate

Throws:

AmqpException

send

public void send(java.lang.String exchange,
                 java.lang.String routingKey,
                 Message message)
          throws AmqpException

Specified by:

send in interface AmqpTemplate

Throws:

AmqpException

convertAndSend

public void convertAndSend(java.lang.Object object)
                    throws AmqpException

Specified by:

convertAndSend in interface AmqpTemplate

Throws:

AmqpException

convertAndSend

public void convertAndSend(java.lang.String routingKey,
                           java.lang.Object object)
                    throws AmqpException

Specified by:

convertAndSend in interface AmqpTemplate

Throws:

AmqpException

convertAndSend

public void convertAndSend(java.lang.String exchange,
                           java.lang.String routingKey,
                           java.lang.Object object)
                    throws AmqpException

Specified by:

convertAndSend in interface AmqpTemplate

Throws:

AmqpException

convertAndSend

public void convertAndSend(java.lang.Object message,
                           MessagePostProcessor messagePostProcessor)
                    throws AmqpException

Specified by:

convertAndSend in interface AmqpTemplate

Throws:

AmqpException

convertAndSend

public void convertAndSend(java.lang.String routingKey,
                           java.lang.Object message,
                           MessagePostProcessor messagePostProcessor)
                    throws AmqpException

Specified by:

convertAndSend in interface AmqpTemplate

Throws:

AmqpException

convertAndSend

public void convertAndSend(java.lang.String exchange,
                           java.lang.String routingKey,
                           java.lang.Object message,
                           MessagePostProcessor messagePostProcessor)
                    throws AmqpException

Specified by:

convertAndSend in interface AmqpTemplate

Throws:

AmqpException

receive

public Message receive()
                throws AmqpException

Specified by:

receive in interface AmqpTemplate

Throws:

AmqpException

receive

public Message receive(java.lang.String queueName)

Specified by:

receive in interface AmqpTemplate

receiveAndConvert

public java.lang.Object receiveAndConvert()
                                   throws AmqpException

Specified by:

receiveAndConvert in interface AmqpTemplate

Throws:

AmqpException

receiveAndConvert

public java.lang.Object receiveAndConvert(java.lang.String queueName)
                                   throws AmqpException

Specified by:

receiveAndConvert in interface AmqpTemplate

Throws:

AmqpException

sendAndReceive

public Message sendAndReceive(Message message)
                       throws AmqpException

Specified by:

sendAndReceive in interface AmqpTemplate

Throws:

AmqpException

sendAndReceive

public Message sendAndReceive(java.lang.String routingKey,
                              Message message)
                       throws AmqpException

Specified by:

sendAndReceive in interface AmqpTemplate

Throws:

AmqpException

sendAndReceive

public Message sendAndReceive(java.lang.String exchange,
                              java.lang.String routingKey,
                              Message message)
                       throws AmqpException

Specified by:

sendAndReceive in interface AmqpTemplate

Throws:

AmqpException

convertSendAndReceive

public java.lang.Object convertSendAndReceive(java.lang.Object message)
                                       throws AmqpException

Specified by:

convertSendAndReceive in interface AmqpTemplate

Throws:

AmqpException

convertSendAndReceive

public java.lang.Object convertSendAndReceive(java.lang.String routingKey,
                                              java.lang.Object message)
                                       throws AmqpException

Specified by:

convertSendAndReceive in interface AmqpTemplate

Throws:

AmqpException

convertSendAndReceive

public java.lang.Object convertSendAndReceive(java.lang.String exchange,
                                              java.lang.String routingKey,
                                              java.lang.Object message)
                                       throws AmqpException

Specified by:

convertSendAndReceive in interface AmqpTemplate

Throws:

AmqpException

convertSendAndReceive

public java.lang.Object convertSendAndReceive(java.lang.Object message,
                                              MessagePostProcessor messagePostProcessor)
                                       throws AmqpException

Specified by:

convertSendAndReceive in interface AmqpTemplate

Throws:

AmqpException

convertSendAndReceive

public java.lang.Object convertSendAndReceive(java.lang.String routingKey,
                                              java.lang.Object message,
                                              MessagePostProcessor messagePostProcessor)
                                       throws AmqpException

Specified by:

convertSendAndReceive in interface AmqpTemplate

Throws:

AmqpException

convertSendAndReceive

public java.lang.Object convertSendAndReceive(java.lang.String exchange,
                                              java.lang.String routingKey,
                                              java.lang.Object message,
                                              MessagePostProcessor messagePostProcessor)
                                       throws AmqpException

Specified by:

convertSendAndReceive in interface AmqpTemplate

Throws:

AmqpException

doSendAndReceive

protected Message doSendAndReceive(java.lang.String exchange,
                                   java.lang.String routingKey,
                                   Message message)

Send a message and wait for a reply.

Parameters:

exchange - the exchange name

routingKey - the routing key

message - the message to send

Returns:

the message that is received in reply

execute

public <T> T execute(ChannelCallback<T> action)

Specified by:

execute in interface RabbitOperations

doSend

protected void doSend(com.rabbitmq.client.Channel channel,
                      java.lang.String exchange,
                      java.lang.String routingKey,
                      Message message)
               throws java.lang.Exception

Send the given message to the specified exchange.

Parameters:

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

Throws:

java.io.IOException - if thrown by RabbitMQ API methods

java.lang.Exception

isChannelLocallyTransacted

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.

Parameters:

channel - the Channel to check

Returns:

whether the given Channel is locally transacted

See Also:

ConnectionFactoryUtils.isChannelTransactional(com.rabbitmq.client.Channel, org.springframework.amqp.rabbit.connection.ConnectionFactory), RabbitAccessor.isChannelTransacted()