Class RabbitMessagingTemplate

java.lang.Object

org.springframework.messaging.core.AbstractMessageSendingTemplate<String>

org.springframework.messaging.core.AbstractMessageReceivingTemplate<String>

org.springframework.messaging.core.AbstractMessagingTemplate<String>

org.springframework.amqp.rabbit.core.RabbitMessagingTemplate

All Implemented Interfaces:

RabbitMessageOperations, InitializingBean, MessageReceivingOperations<String>, MessageRequestReplyOperations<String>, MessageSendingOperations<String>

public class RabbitMessagingTemplate
extends AbstractMessagingTemplate<String>
implements RabbitMessageOperations, InitializingBean

An implementation of RabbitMessageOperations.

Since:

1.4

Author:

Stephane Nicoll, Gary Russell, Artem Bilan

Field Summary

Fields inherited from class org.springframework.messaging.core.AbstractMessageSendingTemplate

CONVERSION_HINT_HEADER, logger

Constructor Summary

Constructors

Constructor	Description
RabbitMessagingTemplate()	Constructor for use with bean properties.
RabbitMessagingTemplate(RabbitTemplate rabbitTemplate)	Create an instance with the RabbitTemplate to use.

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
protected MessagingException	convertAmqpException(RuntimeException ex)
protected @Nullable Message<?>	convertAmqpMessage(@Nullable Message message)
void	convertAndSend(@Nullable String exchange, @Nullable String routingKey, Object payload, @Nullable Map<String,Object> headers, @Nullable MessagePostProcessor postProcessor)	Convert the given Object to serialized form, possibly using a MessageConverter, wrap it as a message with the given headers, apply the given post processor, and send the resulting message to a specific exchange with a specific routing key.
<T> @Nullable T	convertSendAndReceive(@Nullable String exchange, @Nullable String routingKey, Object request, @Nullable Map<String,Object> headers, Class<T> targetClass, @Nullable MessagePostProcessor requestPostProcessor)	Convert the given request Object to serialized form, possibly using a MessageConverter, wrap it as a message with the given headers, apply the given post processor and send the resulting Message to a specific exchange with a specific routing key, receive the reply and convert its body of the given target class.
protected @Nullable Message<?>	doReceive(String destination)
protected void	doSend(@Nullable String exchange, @Nullable String routingKey, Message<?> message)
protected void	doSend(@Nullable String destination, Message<?> message)
protected @Nullable Message<?>	doSendAndReceive(@Nullable String exchange, @Nullable String routingKey, Message<?> requestMessage)
protected @Nullable Message<?>	doSendAndReceive(@Nullable String destination, Message<?> requestMessage)
MessageConverter	getAmqpMessageConverter()
RabbitTemplate	getRabbitTemplate()
@Nullable Message<?>	receive()
<T> @Nullable T	receiveAndConvert(Class<T> targetClass)
void	send(@Nullable String exchange, @Nullable String routingKey, Message<?> message)	Send a message to a specific exchange with a specific routing key.
@Nullable Message<?>	sendAndReceive(@Nullable String exchange, @Nullable String routingKey, Message<?> requestMessage)	Send a request message to a specific exchange with a specific routing key and wait for the reply.
void	setAmqpMessageConverter(MessageConverter amqpMessageConverter)	Set the MessageConverter to use to convert a Message from the messaging to and from a Message.
void	setRabbitTemplate(RabbitTemplate rabbitTemplate)	Set the RabbitTemplate to use.
void	setUseTemplateDefaultReceiveQueue(boolean useTemplateDefaultReceiveQueue)	When true, use the underlying RabbitTemplate's defaultReceiveQueue property (if configured) for receive only methods instead of the defaultDestination configured in this template.

Methods inherited from class org.springframework.messaging.core.AbstractMessagingTemplate

convertSendAndReceive, convertSendAndReceive, convertSendAndReceive, convertSendAndReceive, convertSendAndReceive, convertSendAndReceive, convertSendAndReceive, convertSendAndReceive, sendAndReceive, sendAndReceive

Methods inherited from class org.springframework.messaging.core.AbstractMessageReceivingTemplate

doConvert, receive, receiveAndConvert

Methods inherited from class org.springframework.messaging.core.AbstractMessageSendingTemplate

convertAndSend, convertAndSend, convertAndSend, convertAndSend, convertAndSend, convertAndSend, convertAndSend, convertAndSend, doConvert, getDefaultDestination, getMessageConverter, getRequiredDefaultDestination, processHeadersToSend, send, send, setDefaultDestination, setMessageConverter

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.messaging.core.MessageReceivingOperations

receive, receiveAndConvert

Methods inherited from interface org.springframework.messaging.core.MessageRequestReplyOperations

convertSendAndReceive, convertSendAndReceive, convertSendAndReceive, convertSendAndReceive, convertSendAndReceive, convertSendAndReceive, convertSendAndReceive, convertSendAndReceive, sendAndReceive, sendAndReceive

Methods inherited from interface org.springframework.messaging.core.MessageSendingOperations

convertAndSend, convertAndSend, convertAndSend, convertAndSend, convertAndSend, convertAndSend, convertAndSend, convertAndSend, send, send

Methods inherited from interface org.springframework.amqp.rabbit.core.RabbitMessageOperations

convertAndSend, convertAndSend, convertAndSend, convertSendAndReceive, convertSendAndReceive, convertSendAndReceive

Constructor Details

RabbitMessagingTemplate

public RabbitMessagingTemplate()

Constructor for use with bean properties. Requires setRabbitTemplate(org.springframework.amqp.rabbit.core.RabbitTemplate) to be called.

RabbitMessagingTemplate

public RabbitMessagingTemplate(RabbitTemplate rabbitTemplate)

Create an instance with the RabbitTemplate to use.

Parameters:

rabbitTemplate - the template.

Method Details

setRabbitTemplate

public void setRabbitTemplate(RabbitTemplate rabbitTemplate)

Set the RabbitTemplate to use.

Parameters:

rabbitTemplate - the template.

getRabbitTemplate

public RabbitTemplate getRabbitTemplate()

Returns:

the configured RabbitTemplate.

setAmqpMessageConverter

public void setAmqpMessageConverter(MessageConverter amqpMessageConverter)

Set the MessageConverter to use to convert a Message from the messaging to and from a Message. By default, a MessagingMessageConverter is defined using the provided RabbitTemplate's message converter (a SimpleMessageConverter by default) to convert the payload of the message.

Consider configuring a MessagingMessageConverter with a different payload converter for more advanced scenarios.

Parameters:

amqpMessageConverter - the message converter.

See Also:

• MessagingMessageConverter

getAmqpMessageConverter

public MessageConverter getAmqpMessageConverter()

Returns:

the MessageConverter to use to convert a Message from the messaging to and from a Message.

setUseTemplateDefaultReceiveQueue

public void setUseTemplateDefaultReceiveQueue(boolean useTemplateDefaultReceiveQueue)

When true, use the underlying RabbitTemplate's defaultReceiveQueue property (if configured) for receive only methods instead of the defaultDestination configured in this template. Set this to true to use the template's queue instead. Default false, but will be true in a future release.

Parameters:

useTemplateDefaultReceiveQueue - true to use the template's queue.

Since:

2.2.22

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface InitializingBean

send

public void send(@Nullable String exchange,
 @Nullable String routingKey,
 Message<?> message)
          throws MessagingException

Description copied from interface: RabbitMessageOperations

Send a message to a specific exchange with a specific routing key.

Specified by:

send in interface RabbitMessageOperations

Parameters:

exchange - the name of the exchange

routingKey - the routing key

message - the message to send

Throws:

MessagingException - a messaging exception.

convertAndSend

public void convertAndSend(@Nullable String exchange,
 @Nullable String routingKey,
 Object payload,
 @Nullable Map<String,Object> headers,
 @Nullable MessagePostProcessor postProcessor)
                    throws MessagingException

Description copied from interface: RabbitMessageOperations

Convert the given Object to serialized form, possibly using a MessageConverter, wrap it as a message with the given headers, apply the given post processor, and send the resulting message to a specific exchange with a specific routing key.

Specified by:

convertAndSend in interface RabbitMessageOperations

Parameters:

exchange - the name of the exchange

routingKey - the routing key

payload - the Object to use as payload

headers - headers for the message to send

postProcessor - the post processor to apply to the message

Throws:

MessagingException - a messaging exception.

sendAndReceive

public @Nullable Message<?> sendAndReceive(@Nullable String exchange,
 @Nullable String routingKey,
 Message<?> requestMessage)
                                    throws MessagingException

Description copied from interface: RabbitMessageOperations

Send a request message to a specific exchange with a specific routing key and wait for the reply.

Specified by:

sendAndReceive in interface RabbitMessageOperations

Parameters:

exchange - the name of the exchange

routingKey - the routing key

requestMessage - the message to send

Returns:

the reply, possibly null if the message could not be received, for example due to a timeout

Throws:

MessagingException - a messaging exception.

convertSendAndReceive

public <T> @Nullable T convertSendAndReceive(@Nullable String exchange,
 @Nullable String routingKey,
 Object request,
 @Nullable Map<String,Object> headers,
 Class<T> targetClass,
 @Nullable MessagePostProcessor requestPostProcessor)
                                      throws MessagingException

Description copied from interface: RabbitMessageOperations

Convert the given request Object to serialized form, possibly using a MessageConverter, wrap it as a message with the given headers, apply the given post processor and send the resulting Message to a specific exchange with a specific routing key, receive the reply and convert its body of the given target class.

Specified by:

convertSendAndReceive in interface RabbitMessageOperations

Type Parameters:

T - return type

Parameters:

exchange - the name of the exchange

routingKey - the routing key

request - payload for the request message to send

headers - headers for the message to send

targetClass - the target type to convert the payload of the reply to

requestPostProcessor - post process to apply to the request message

Returns:

the payload of the reply message, possibly null if the message could not be received, for example due to a timeout

Throws:

MessagingException - a messaging exception.

doSend

protected void doSend(@Nullable String destination,
 Message<?> message)

Specified by:

doSend in class AbstractMessageSendingTemplate<String>

doSend

protected void doSend(@Nullable String exchange,
 @Nullable String routingKey,
 Message<?> message)

receive

public @Nullable Message<?> receive()

Specified by:

receive in interface MessageReceivingOperations<String>

Overrides:

receive in class AbstractMessageReceivingTemplate<String>

receiveAndConvert

public <T> @Nullable T receiveAndConvert(Class<T> targetClass)

Specified by:

receiveAndConvert in interface MessageReceivingOperations<String>

Overrides:

receiveAndConvert in class AbstractMessageReceivingTemplate<String>

doReceive

protected @Nullable Message<?> doReceive(String destination)

Specified by:

doReceive in class AbstractMessageReceivingTemplate<String>

doSendAndReceive

protected @Nullable Message<?> doSendAndReceive(@Nullable String destination,
 Message<?> requestMessage)

Specified by:

doSendAndReceive in class AbstractMessagingTemplate<String>

doSendAndReceive

protected @Nullable Message<?> doSendAndReceive(@Nullable String exchange,
 @Nullable String routingKey,
 Message<?> requestMessage)

convertAmqpMessage

protected @Nullable Message<?> convertAmqpMessage(@Nullable Message message)

convertAmqpException

protected MessagingException convertAmqpException(RuntimeException ex)