Class RabbitAmqpTemplate

java.lang.Object

org.springframework.amqp.rabbitmq.client.RabbitAmqpTemplate

All Implemented Interfaces:

AsyncAmqpTemplate, DisposableBean, InitializingBean

public class RabbitAmqpTemplate
extends Object
implements AsyncAmqpTemplate, InitializingBean, DisposableBean

The AmqpTemplate for RabbitMQ AMQP 1.0 protocol support. A Spring-friendly wrapper around Environment.connectionBuilder();

Since:

4.0

Author:

Artem Bilan

Constructor Summary

Constructors

Constructor	Description
RabbitAmqpTemplate(com.rabbitmq.client.amqp.Connection amqpConnection)

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
CompletableFuture<Boolean>	convertAndSend(Object message)	Publish a message from converted body to the default exchange and routing key (if any) (or queue) configured on this template.
CompletableFuture<Boolean>	convertAndSend(Object message, @Nullable MessagePostProcessor messagePostProcessor)
CompletableFuture<Boolean>	convertAndSend(String exchange, @Nullable String routingKey, Object message)
CompletableFuture<Boolean>	convertAndSend(String exchange, @Nullable String routingKey, Object message, @Nullable MessagePostProcessor messagePostProcessor)
CompletableFuture<Boolean>	convertAndSend(String queue, Object message)
CompletableFuture<Boolean>	convertAndSend(String queue, Object message, @Nullable MessagePostProcessor messagePostProcessor)
<C> CompletableFuture<C>	convertSendAndReceive(Object object)	Convert the object to a message and send it to the default exchange with the default routing key.
<C> CompletableFuture<C>	convertSendAndReceive(Object object, MessagePostProcessor messagePostProcessor)	Convert the object to a message and send it to the default exchange with the default routing key after invoking the MessagePostProcessor.
<C> CompletableFuture<C>	convertSendAndReceive(String routingKey, Object object)	Convert the object to a message and send it to the default exchange with the provided routing key.
<C> CompletableFuture<C>	convertSendAndReceive(String routingKey, Object object, MessagePostProcessor messagePostProcessor)	Convert the object to a message and send it to the default exchange with the provided routing key after invoking the MessagePostProcessor.
<C> CompletableFuture<C>	convertSendAndReceive(String exchange, String routingKey, Object object)	Convert the object to a message and send it to the provided exchange and routing key.
<C> CompletableFuture<C>	convertSendAndReceive(String exchange, String routingKey, Object object, @Nullable MessagePostProcessor messagePostProcessor)	Convert the object to a message and send it to the provided exchange and routing key after invoking the MessagePostProcessor.
<C> CompletableFuture<C>	convertSendAndReceiveAsType(Object object, MessagePostProcessor messagePostProcessor, ParameterizedTypeReference<C> responseType)	Convert the object to a message and send it to the default exchange with the default routing key after invoking the MessagePostProcessor.
<C> CompletableFuture<C>	convertSendAndReceiveAsType(Object object, ParameterizedTypeReference<C> responseType)	Convert the object to a message and send it to the default exchange with the default routing key.
<C> CompletableFuture<C>	convertSendAndReceiveAsType(String routingKey, Object object, @Nullable MessagePostProcessor messagePostProcessor, @Nullable ParameterizedTypeReference<C> responseType)	Convert the object to a message and send it to the default exchange with the provided routing key after invoking the MessagePostProcessor.
<C> CompletableFuture<C>	convertSendAndReceiveAsType(String routingKey, Object object, ParameterizedTypeReference<C> responseType)	Convert the object to a message and send it to the default exchange with the provided routing key.
<C> CompletableFuture<C>	convertSendAndReceiveAsType(String exchange, String routingKey, Object object, @Nullable MessagePostProcessor messagePostProcessor, @Nullable ParameterizedTypeReference<C> responseType)	Convert the object to a message and send it to the provided exchange and routing key after invoking the MessagePostProcessor.
<C> CompletableFuture<C>	convertSendAndReceiveAsType(String exchange, String routingKey, Object object, ParameterizedTypeReference<C> responseType)	Convert the object to a message and send it to the provided exchange and routing key.
void	destroy()
CompletableFuture<Message>	receive()
CompletableFuture<Message>	receive(String queueName)
CompletableFuture<Object>	receiveAndConvert()
CompletableFuture<Object>	receiveAndConvert(String queueName)
<T> CompletableFuture<T>	receiveAndConvert(String queueName, ParameterizedTypeReference<T> type)	Receive a message from setDefaultReceiveQueue(String) and convert its body to the expected type.
<T> CompletableFuture<T>	receiveAndConvert(ParameterizedTypeReference<T> type)	Receive a message from setDefaultReceiveQueue(String) and convert its body to the expected type.
<R, S> boolean	receiveAndReply(String queueName, ReceiveAndReplyCallback<R,S> callback)
<R, S> boolean	receiveAndReply(String queueName, ReceiveAndReplyCallback<R,S> callback, String replyExchange, String replyRoutingKey)
<R, S> boolean	receiveAndReply(String queueName, ReceiveAndReplyCallback<R,S> callback, ReplyToAddressCallback<S> replyToAddressCallback)
<R, S> boolean	receiveAndReply(ReceiveAndReplyCallback<R,S> callback)
<R, S> boolean	receiveAndReply(ReceiveAndReplyCallback<R,S> callback, String replyExchange, String replyRoutingKey)
<R, S> boolean	receiveAndReply(ReceiveAndReplyCallback<R,S> callback, ReplyToAddressCallback<S> replyToAddressCallback)
CompletableFuture<Boolean>	send(String exchange, @Nullable String routingKey, Message message)
CompletableFuture<Boolean>	send(String queue, Message message)	Publish the message to the provided queue.
CompletableFuture<Boolean>	send(Message message)	Publish a message to the default exchange and routing key (if any) (or queue) configured on this template.
CompletableFuture<Message>	sendAndReceive(String exchange, String routingKey, Message message)	Send a message to the supplied exchange and routing key.
CompletableFuture<Message>	sendAndReceive(String routingKey, Message message)	Send a message to the default exchange with the supplied routing key.
CompletableFuture<Message>	sendAndReceive(Message message)	Send a message to the default exchange with the default routing key.
void	setDefaultReceiveQueue(String queue)	The name of the default queue to receive messages from when none is specified explicitly.
void	setExchange(String exchange)	Set a default exchange for publishing.
void	setKey(String key)	Set a default routing key.
void	setListeners(com.rabbitmq.client.amqp.Resource.StateListener... listeners)
void	setMessageConverter(MessageConverter messageConverter)	Set a converter for convertAndSend(Object) operations.
void	setPublishTimeout(Duration timeout)
void	setQueue(String queue)	Set default queue for publishing.

Methods inherited from class java.lang.Object

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

Constructor Details

RabbitAmqpTemplate

public RabbitAmqpTemplate(com.rabbitmq.client.amqp.Connection amqpConnection)

Method Details

setListeners

public void setListeners(com.rabbitmq.client.amqp.Resource.StateListener... listeners)

setPublishTimeout

public void setPublishTimeout(Duration timeout)

setExchange

public void setExchange(String exchange)

Set a default exchange for publishing. Cannot be real default AMQP exchange. The setQueue(String) is recommended instead. Mutually exclusive with setQueue(String).

Parameters:

exchange - the default exchange

setKey

public void setKey(String key)

Set a default routing key. Mutually exclusive with setQueue(String).

Parameters:

key - the default routing key.

setQueue

public void setQueue(String queue)

Set default queue for publishing. Mutually exclusive with setExchange(String) and setKey(String).

Parameters:

queue - the default queue.

setMessageConverter

public void setMessageConverter(MessageConverter messageConverter)

Set a converter for convertAndSend(Object) operations.

Parameters:

messageConverter - the converter.

setDefaultReceiveQueue

public void setDefaultReceiveQueue(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 operation.

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface InitializingBean

destroy

public void destroy()

Specified by:

destroy in interface DisposableBean

send

public CompletableFuture<Boolean> send(Message message)

Publish a message to the default exchange and routing key (if any) (or queue) configured on this template.

Specified by:

send in interface AsyncAmqpTemplate

Parameters:

message - to publish

Returns:

the CompletableFuture as an async result of the message publication.

send

public CompletableFuture<Boolean> send(String queue,
 Message message)

Publish the message to the provided queue.

Specified by:

send in interface AsyncAmqpTemplate

Parameters:

queue - to publish

message - to publish

Returns:

the CompletableFuture as an async result of the message publication.

send

public CompletableFuture<Boolean> send(String exchange,
 @Nullable String routingKey,
 Message message)

Specified by:

send in interface AsyncAmqpTemplate

convertAndSend

public CompletableFuture<Boolean> convertAndSend(Object message)

Publish a message from converted body to the default exchange and routing key (if any) (or queue) configured on this template.

Specified by:

convertAndSend in interface AsyncAmqpTemplate

Parameters:

message - to publish

Returns:

the CompletableFuture as an async result of the message publication.

convertAndSend

public CompletableFuture<Boolean> convertAndSend(String queue,
 Object message)

Specified by:

convertAndSend in interface AsyncAmqpTemplate

convertAndSend

public CompletableFuture<Boolean> convertAndSend(String exchange,
 @Nullable String routingKey,
 Object message)

Specified by:

convertAndSend in interface AsyncAmqpTemplate

convertAndSend

public CompletableFuture<Boolean> convertAndSend(Object message,
 @Nullable MessagePostProcessor messagePostProcessor)

Specified by:

convertAndSend in interface AsyncAmqpTemplate

convertAndSend

public CompletableFuture<Boolean> convertAndSend(String queue,
 Object message,
 @Nullable MessagePostProcessor messagePostProcessor)

Specified by:

convertAndSend in interface AsyncAmqpTemplate

convertAndSend

public CompletableFuture<Boolean> convertAndSend(String exchange,
 @Nullable String routingKey,
 Object message,
 @Nullable MessagePostProcessor messagePostProcessor)

Specified by:

convertAndSend in interface AsyncAmqpTemplate

receive

public CompletableFuture<Message> receive()

Specified by:

receive in interface AsyncAmqpTemplate

receive

public CompletableFuture<Message> receive(String queueName)

Specified by:

receive in interface AsyncAmqpTemplate

receiveAndConvert

public CompletableFuture<Object> receiveAndConvert()

Specified by:

receiveAndConvert in interface AsyncAmqpTemplate

receiveAndConvert

public CompletableFuture<Object> receiveAndConvert(String queueName)

Specified by:

receiveAndConvert in interface AsyncAmqpTemplate

receiveAndConvert

public <T> CompletableFuture<T> receiveAndConvert(ParameterizedTypeReference<T> type)

Receive a message from setDefaultReceiveQueue(String) and convert its body to the expected type. The setMessageConverter(MessageConverter) must be an implementation of SmartMessageConverter.

Specified by:

receiveAndConvert in interface AsyncAmqpTemplate

Parameters:

type - the type to covert received result.

Returns:

the CompletableFuture with a result.

receiveAndConvert

public <T> CompletableFuture<T> receiveAndConvert(String queueName,
 ParameterizedTypeReference<T> type)

Receive a message from setDefaultReceiveQueue(String) and convert its body to the expected type. The setMessageConverter(MessageConverter) must be an implementation of SmartMessageConverter.

Specified by:

receiveAndConvert in interface AsyncAmqpTemplate

Parameters:

queueName - the queue to consume message from.

type - the type to covert received result.

Returns:

the CompletableFuture with a result.

receiveAndReply

public <R,
S> boolean receiveAndReply(ReceiveAndReplyCallback<R,S> callback)
                               throws AmqpException

Throws:

AmqpException

receiveAndReply

public <R,
S> boolean receiveAndReply(String queueName,
 ReceiveAndReplyCallback<R,S> callback)
                               throws AmqpException

Throws:

AmqpException

receiveAndReply

public <R,
S> boolean receiveAndReply(ReceiveAndReplyCallback<R,S> callback,
 String replyExchange,
 String replyRoutingKey)
                               throws AmqpException

Throws:

AmqpException

receiveAndReply

public <R,
S> boolean receiveAndReply(String queueName,
 ReceiveAndReplyCallback<R,S> callback,
 String replyExchange,
 String replyRoutingKey)
                               throws AmqpException

Throws:

AmqpException

receiveAndReply

public <R,
S> boolean receiveAndReply(ReceiveAndReplyCallback<R,S> callback,
 ReplyToAddressCallback<S> replyToAddressCallback)
                               throws AmqpException

Throws:

AmqpException

receiveAndReply

public <R,
S> boolean receiveAndReply(String queueName,
 ReceiveAndReplyCallback<R,S> callback,
 ReplyToAddressCallback<S> replyToAddressCallback)
                               throws AmqpException

Throws:

AmqpException

sendAndReceive

public CompletableFuture<Message> sendAndReceive(Message message)

Description copied from interface: AsyncAmqpTemplate

Send a message to the default exchange with the default routing key. If the message contains a correlationId property, it must be unique.

Specified by:

sendAndReceive in interface AsyncAmqpTemplate

Parameters:

message - the message.

Returns:

the CompletableFuture.

sendAndReceive

public CompletableFuture<Message> sendAndReceive(String routingKey,
 Message message)

Description copied from interface: AsyncAmqpTemplate

Send a message to the default exchange with the supplied routing key. If the message contains a correlationId property, it must be unique.

Specified by:

sendAndReceive in interface AsyncAmqpTemplate

Parameters:

routingKey - the routing key.

message - the message.

Returns:

the CompletableFuture.

sendAndReceive

public CompletableFuture<Message> sendAndReceive(String exchange,
 String routingKey,
 Message message)

Description copied from interface: AsyncAmqpTemplate

Send a message to the supplied exchange and routing key. If the message contains a correlationId property, it must be unique.

Specified by:

sendAndReceive in interface AsyncAmqpTemplate

Parameters:

exchange - the exchange.

routingKey - the routing key.

message - the message.

Returns:

the CompletableFuture.

convertSendAndReceive

public <C> CompletableFuture<C> convertSendAndReceive(Object object)

Description copied from interface: AsyncAmqpTemplate

Convert the object to a message and send it to the default exchange with the default routing key.

Specified by:

convertSendAndReceive in interface AsyncAmqpTemplate

Type Parameters:

C - the expected result type.

Parameters:

object - the object to convert.

Returns:

the CompletableFuture.

convertSendAndReceive

public <C> CompletableFuture<C> convertSendAndReceive(String routingKey,
 Object object)

Description copied from interface: AsyncAmqpTemplate

Convert the object to a message and send it to the default exchange with the provided routing key.

Specified by:

convertSendAndReceive in interface AsyncAmqpTemplate

Type Parameters:

C - the expected result type.

Parameters:

routingKey - the routing key.

object - the object to convert.

Returns:

the CompletableFuture.

convertSendAndReceive

public <C> CompletableFuture<C> convertSendAndReceive(String exchange,
 String routingKey,
 Object object)

Description copied from interface: AsyncAmqpTemplate

Convert the object to a message and send it to the provided exchange and routing key.

Specified by:

convertSendAndReceive in interface AsyncAmqpTemplate

Type Parameters:

C - the expected result type.

Parameters:

exchange - the exchange.

routingKey - the routing key.

object - the object to convert.

Returns:

the CompletableFuture.

convertSendAndReceive

public <C> CompletableFuture<C> convertSendAndReceive(Object object,
 MessagePostProcessor messagePostProcessor)

Description copied from interface: AsyncAmqpTemplate

Convert the object to a message and send it to the default exchange with the default routing key after invoking the MessagePostProcessor. If the post processor adds a correlationId property, it must be unique.

Specified by:

convertSendAndReceive in interface AsyncAmqpTemplate

Type Parameters:

C - the expected result type.

Parameters:

object - the object to convert.

messagePostProcessor - the post processor.

Returns:

the CompletableFuture.

convertSendAndReceive

public <C> CompletableFuture<C> convertSendAndReceive(String routingKey,
 Object object,
 MessagePostProcessor messagePostProcessor)

Description copied from interface: AsyncAmqpTemplate

Convert the object to a message and send it to the default exchange with the provided routing key after invoking the MessagePostProcessor. If the post processor adds a correlationId property, it must be unique.

Specified by:

convertSendAndReceive in interface AsyncAmqpTemplate

Type Parameters:

C - the expected result type.

Parameters:

routingKey - the routing key.

object - the object to convert.

messagePostProcessor - the post processor.

Returns:

the CompletableFuture.

convertSendAndReceive

public <C> CompletableFuture<C> convertSendAndReceive(String exchange,
 String routingKey,
 Object object,
 @Nullable MessagePostProcessor messagePostProcessor)

Description copied from interface: AsyncAmqpTemplate

Convert the object to a message and send it to the provided exchange and routing key after invoking the MessagePostProcessor. If the post processor adds a correlationId property, it must be unique.

Specified by:

convertSendAndReceive in interface AsyncAmqpTemplate

Type Parameters:

C - the expected result type.

Parameters:

exchange - the exchange

routingKey - the routing key.

object - the object to convert.

messagePostProcessor - the post processor.

Returns:

the CompletableFuture.

convertSendAndReceiveAsType

public <C> CompletableFuture<C> convertSendAndReceiveAsType(Object object,
 ParameterizedTypeReference<C> responseType)

Description copied from interface: AsyncAmqpTemplate

Convert the object to a message and send it to the default exchange with the default routing key.

Specified by:

convertSendAndReceiveAsType in interface AsyncAmqpTemplate

Type Parameters:

C - the expected result type.

Parameters:

object - the object to convert.

responseType - the response type.

Returns:

the CompletableFuture.

convertSendAndReceiveAsType

public <C> CompletableFuture<C> convertSendAndReceiveAsType(String routingKey,
 Object object,
 ParameterizedTypeReference<C> responseType)

Description copied from interface: AsyncAmqpTemplate

Convert the object to a message and send it to the default exchange with the provided routing key.

Specified by:

convertSendAndReceiveAsType in interface AsyncAmqpTemplate

Type Parameters:

C - the expected result type.

Parameters:

routingKey - the routing key.

object - the object to convert.

responseType - the response type.

Returns:

the CompletableFuture.

convertSendAndReceiveAsType

public <C> CompletableFuture<C> convertSendAndReceiveAsType(String exchange,
 String routingKey,
 Object object,
 ParameterizedTypeReference<C> responseType)

Description copied from interface: AsyncAmqpTemplate

Convert the object to a message and send it to the provided exchange and routing key.

Specified by:

convertSendAndReceiveAsType in interface AsyncAmqpTemplate

Type Parameters:

C - the expected result type.

Parameters:

exchange - the exchange.

routingKey - the routing key.

object - the object to convert.

responseType - the response type.

Returns:

the CompletableFuture.

convertSendAndReceiveAsType

public <C> CompletableFuture<C> convertSendAndReceiveAsType(Object object,
 MessagePostProcessor messagePostProcessor,
 ParameterizedTypeReference<C> responseType)

Description copied from interface: AsyncAmqpTemplate

Convert the object to a message and send it to the default exchange with the default routing key after invoking the MessagePostProcessor. If the post processor adds a correlationId property, it must be unique.

Specified by:

convertSendAndReceiveAsType in interface AsyncAmqpTemplate

Type Parameters:

C - the expected result type.

Parameters:

object - the object to convert.

messagePostProcessor - the post processor.

responseType - the response type.

Returns:

the CompletableFuture.

convertSendAndReceiveAsType

public <C> CompletableFuture<C> convertSendAndReceiveAsType(String routingKey,
 Object object,
 @Nullable MessagePostProcessor messagePostProcessor,
 @Nullable ParameterizedTypeReference<C> responseType)

Description copied from interface: AsyncAmqpTemplate

Convert the object to a message and send it to the default exchange with the provided routing key after invoking the MessagePostProcessor. If the post processor adds a correlationId property, it must be unique.

Specified by:

convertSendAndReceiveAsType in interface AsyncAmqpTemplate

Type Parameters:

C - the expected result type.

Parameters:

routingKey - the routing key.

object - the object to convert.

messagePostProcessor - the post processor.

responseType - the response type.

Returns:

the CompletableFuture.

convertSendAndReceiveAsType

public <C> CompletableFuture<C> convertSendAndReceiveAsType(String exchange,
 String routingKey,
 Object object,
 @Nullable MessagePostProcessor messagePostProcessor,
 @Nullable ParameterizedTypeReference<C> responseType)

Description copied from interface: AsyncAmqpTemplate

Convert the object to a message and send it to the provided exchange and routing key after invoking the MessagePostProcessor. If the post processor adds a correlationId property, it must be unique.

Specified by:

convertSendAndReceiveAsType in interface AsyncAmqpTemplate

Type Parameters:

C - the expected result type.

Parameters:

exchange - the exchange

routingKey - the routing key.

object - the object to convert.

messagePostProcessor - the post processor.

responseType - the response type.

Returns:

the CompletableFuture.