Class RabbitAmqpTemplate

java.lang.Object

org.springframework.amqp.rabbitmq.client.RabbitAmqpTemplate

All Implemented Interfaces:

AsyncAmqpTemplate, DisposableBean

public class RabbitAmqpTemplate
extends Object
implements AsyncAmqpTemplate, 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(AmqpConnectionFactory connectionFactory)

Method Summary

Modifier and Type	Method	Description
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 exchange, @Nullable 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, @Nullable 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>	convertSendAndReceive(String queue, 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 queue, 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>	convertSendAndReceiveAsType(Object object, @Nullable MessagePostProcessor messagePostProcessor, @Nullable 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 exchange, @Nullable 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, @Nullable String routingKey, Object object, ParameterizedTypeReference<C> responseType)	Convert the object to a message and send it to the provided exchange and routing key.
<C> CompletableFuture<C>	convertSendAndReceiveAsType(String queue, 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 queue, Object object, ParameterizedTypeReference<C> responseType)	Convert the object to a message and send it to the default exchange with the provided routing key.
void	destroy()
CompletableFuture<Message>	receive()
CompletableFuture<Message>	receive(String queueName)	Request a head message from the provided queue.
CompletableFuture<Object>	receiveAndConvert()
CompletableFuture<Object>	receiveAndConvert(String queueName)
<T> CompletableFuture<T>	receiveAndConvert(String queueName, @Nullable ParameterizedTypeReference<T> type)	Receive a message from setReceiveQueue(String) and convert its body to the expected type.
<T> CompletableFuture<T>	receiveAndConvert(@Nullable ParameterizedTypeReference<T> type)	Receive a message from setReceiveQueue(String) and convert its body to the expected type.
<R,S> CompletableFuture<Boolean>	receiveAndReply(String queueName, ReceiveAndReplyCallback<R,S> callback)	Perform a server-side RPC functionality.
<R,S> CompletableFuture<Boolean>	receiveAndReply(ReceiveAndReplyCallback<R,S> callback)
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, @Nullable String routingKey, Message message)	Send a message to the supplied exchange and routing key.
CompletableFuture<Message>	sendAndReceive(String queue, 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	setCompletionTimeout(Duration completionTimeout)	Set a duration for CompletableFuture.orTimeout(long, TimeUnit) on returns.
void	setExchange(String exchange)	Set a default exchange for publishing.
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.
void	setReceiveQueue(String queue)	The name of the default queue to receive messages from when none is specified explicitly.
void	setReplyToQueue(String queue)	The name of the default queue to receive replies from when none is specified explicitly.
void	setRoutingKey(String routingKey)	Set a default routing key.

Methods inherited from class java.lang.Object

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

Constructor Details

RabbitAmqpTemplate

public RabbitAmqpTemplate(AmqpConnectionFactory connectionFactory)

Method Details

setListeners

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

setPublishTimeout

public void setPublishTimeout(Duration timeout)

setCompletionTimeout

public void setCompletionTimeout(Duration completionTimeout)

Set a duration for CompletableFuture.orTimeout(long, TimeUnit) on returns. There is no CompletableFuture API like onTimeout() requested from the CompletableFuture.get(long, TimeUnit), but used in operations AMQP resources have to be closed eventually independently of the CompletableFuture fulfilment. Defaults to 1 minute.

Parameters:

completionTimeout - duration for future completions.

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

setRoutingKey

public void setRoutingKey(String routingKey)

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

Parameters:

routingKey - the default routing key.

setQueue

public void setQueue(String queue)

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

Parameters:

queue - the default queue.

setReceiveQueue

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

setReplyToQueue

public void setReplyToQueue(String queue)

The name of the default queue to receive replies from when none is specified explicitly.

Parameters:

queue - the default queue name to use for send-n-receive operation.

setMessageConverter

public void setMessageConverter(MessageConverter messageConverter)

Set a converter for convertAndSend(Object) operations.

Parameters:

messageConverter - the converter.

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)

Request a head message from the provided queue. A returned CompletableFuture timeouts after setCompletionTimeout(Duration).

Specified by:

receive in interface AsyncAmqpTemplate

Parameters:

queueName - the queue to consume message from.

Returns:

the future with a received message.

See Also:

• setCompletionTimeout(Duration)

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(@Nullable ParameterizedTypeReference<T> type)

Receive a message from setReceiveQueue(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,
 @Nullable ParameterizedTypeReference<T> type)

Receive a message from setReceiveQueue(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> CompletableFuture<Boolean> receiveAndReply(ReceiveAndReplyCallback<R,S> callback)

Specified by:

receiveAndReply in interface AsyncAmqpTemplate

receiveAndReply

public <R,S> CompletableFuture<Boolean> receiveAndReply(String queueName,
 ReceiveAndReplyCallback<R,S> callback)

Description copied from interface: AsyncAmqpTemplate

Perform a server-side RPC functionality. The request message must have a replyTo property. The request messageId property is used for correlation. The callback might not produce a reply with the meaning nothing to answer.

Specified by:

receiveAndReply in interface AsyncAmqpTemplate

Type Parameters:

R - the request body type.

S - the response body type

Parameters:

queueName - the queue to consume request.

callback - an application callback to handle request and produce reply.

Returns:

the completion status: true if no errors, and reply has been produced.

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 exchange,
 @Nullable 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.

sendAndReceive

public CompletableFuture<Message> sendAndReceive(String queue,
 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:

queue - 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 queue,
 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:

queue - the routing key.

object - the object to convert.

Returns:

the CompletableFuture.

convertSendAndReceive

public <C> CompletableFuture<C> convertSendAndReceive(String exchange,
 @Nullable 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 queue,
 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:

queue - the routing key.

object - the object to convert.

messagePostProcessor - the post-processor.

Returns:

the CompletableFuture.

convertSendAndReceive

public <C> CompletableFuture<C> convertSendAndReceive(String exchange,
 @Nullable 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 queue,
 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:

queue - the routing key.

object - the object to convert.

responseType - the response type.

Returns:

the CompletableFuture.

convertSendAndReceiveAsType

public <C> CompletableFuture<C> convertSendAndReceiveAsType(String exchange,
 @Nullable 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,
 @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 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 queue,
 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:

queue - 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,
 @Nullable 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.