Interface AsyncAmqpTemplate

All Known Implementing Classes:
AsyncRabbitTemplate, RabbitAmqpTemplate

public interface AsyncAmqpTemplate
Classes implementing this interface can perform asynchronous send and receive operations using CompletableFutures.
Since:
2.0
Author:
Gary Russell, Artem Bilan
  • Method Details

    • send

      default CompletableFuture<Boolean> send(Message message)
    • send

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

      default CompletableFuture<Boolean> send(String exchange, @Nullable String routingKey, Message message)
    • convertAndSend

      default CompletableFuture<Boolean> convertAndSend(Object message)
    • convertAndSend

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

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

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

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

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

      default CompletableFuture<Message> receive()
    • receive

      default CompletableFuture<Message> receive(String queueName)
    • receiveAndConvert

      default CompletableFuture<Object> receiveAndConvert()
    • receiveAndConvert

      default CompletableFuture<Object> receiveAndConvert(String queueName)
    • receiveAndConvert

      default <T> CompletableFuture<T> receiveAndConvert(ParameterizedTypeReference<T> type)
    • receiveAndConvert

      default <T> CompletableFuture<T> receiveAndConvert(String queueName, ParameterizedTypeReference<T> type)
    • sendAndReceive

      CompletableFuture<Message> sendAndReceive(Message message)
      Send a message to the default exchange with the default routing key. If the message contains a correlationId property, it must be unique.
      Parameters:
      message - the message.
      Returns:
      the CompletableFuture.
    • sendAndReceive

      CompletableFuture<Message> sendAndReceive(String routingKey, Message message)
      Send a message to the default exchange with the supplied routing key. If the message contains a correlationId property, it must be unique.
      Parameters:
      routingKey - the routing key.
      message - the message.
      Returns:
      the CompletableFuture.
    • sendAndReceive

      CompletableFuture<Message> sendAndReceive(String exchange, String routingKey, Message message)
      Send a message to the supplied exchange and routing key. If the message contains a correlationId property, it must be unique.
      Parameters:
      exchange - the exchange.
      routingKey - the routing key.
      message - the message.
      Returns:
      the CompletableFuture.
    • convertSendAndReceive

      <C> CompletableFuture<C> convertSendAndReceive(Object object)
      Convert the object to a message and send it to the default exchange with the default routing key.
      Type Parameters:
      C - the expected result type.
      Parameters:
      object - the object to convert.
      Returns:
      the CompletableFuture.
    • convertSendAndReceive

      <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.
      Type Parameters:
      C - the expected result type.
      Parameters:
      routingKey - the routing key.
      object - the object to convert.
      Returns:
      the CompletableFuture.
    • convertSendAndReceive

      <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.
      Type Parameters:
      C - the expected result type.
      Parameters:
      exchange - the exchange.
      routingKey - the routing key.
      object - the object to convert.
      Returns:
      the CompletableFuture.
    • convertSendAndReceive

      <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. If the post processor adds a correlationId property, it must be unique.
      Type Parameters:
      C - the expected result type.
      Parameters:
      object - the object to convert.
      messagePostProcessor - the post processor.
      Returns:
      the CompletableFuture.
    • convertSendAndReceive

      <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. If the post processor adds a correlationId property, it must be unique.
      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

      <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. If the post processor adds a correlationId property, it must be unique.
      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

      <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.
      Type Parameters:
      C - the expected result type.
      Parameters:
      object - the object to convert.
      responseType - the response type.
      Returns:
      the CompletableFuture.
    • convertSendAndReceiveAsType

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

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

      <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. If the post processor adds a correlationId property, it must be unique.
      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

      <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. If the post processor adds a correlationId property, it must be unique.
      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

      <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. If the post processor adds a correlationId property, it must be unique.
      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.