パッケージ org.springframework.amqp.rabbit

クラス AsyncRabbitTemplate

java.lang.ObjectSE
org.springframework.amqp.rabbit.AsyncRabbitTemplate
実装済みのインターフェース一覧:
AsyncAmqpTemplate、MessageListener、RabbitTemplate.ConfirmCallback、RabbitTemplate.ReturnsCallback、ChannelAwareMessageListener、Aware、BeanNameAware、Lifecycle、Phased、SmartLifecycle
public class AsyncRabbitTemplate extends ObjectSE implements AsyncAmqpTemplate, ChannelAwareMessageListener, RabbitTemplate.ReturnsCallback, RabbitTemplate.ConfirmCallback, BeanNameAware, SmartLifecycle
CompletableFutureSE を返す非同期の送受信操作を提供し、呼び出し元が後で get() またはコールバックを使用して応答を取得できるようにします。

確認が有効になっている場合、未来にはそれ自体が CompletableFutureSE である確認プロパティがあります。パブリッシャーが確認する前に返信が受信された場合、返信はメッセージが公開されたことを暗黙的に示しているため、確認は破棄されます。

返された (配信不能な) リクエストメッセージは、ExecutionExceptionSE の AmqpMessageReturnedException 原因として提示されます。

内部的には、テンプレートは内部で提供または構築された RabbitTemplate および AbstractMessageListenerContainer ( SimpleMessageListenerContainer ) を使用します。外部 RabbitTemplate が提供され、確認 /return が有効になっている場合、このオブジェクトはコールバックである必要があるため、以前にコールバックが登録されていてはなりません。

導入:
1.6
作成者:
Gary Russell, Artem Bilan, FengYang Su, Ngoc Nhan, Ben Efrati

  • フィールドの詳細

  • コンストラクターの詳細

    • AsyncRabbitTemplate

      public AsyncRabbitTemplate(ConnectionFactory connectionFactory, StringSE exchange, StringSE routingKey, StringSE replyQueue)
      提供された引数を使用してインスタンスを構築します。返信は、返信キュー名をルーティングキーとして使用して、デフォルトの交換にルーティングされます。
      パラメーター:
      connectionFactory - 接続ファクトリ。
      exchange - リクエストが送信されるデフォルトの交換。
      routingKey - デフォルトのルーティングキー。
      replyQueue - 応答をリッスンする応答キューの名前。

    • AsyncRabbitTemplate

      public AsyncRabbitTemplate(ConnectionFactory connectionFactory, @Nullable StringSE exchange, StringSE routingKey, StringSE replyQueue, @Nullable StringSE replyAddress)
      指定された引数を使用してインスタンスを構築します。'replyAddress' が null の場合、応答は応答キュー名をルーティングキーとして使用してデフォルトの Exchange にルーティングされます。それ以外の場合は、exchange/routingKey の形式を持ち、メッセージが応答キューにルーティングされるようにする必要があります。
      パラメーター:
      connectionFactory - 接続ファクトリ。
      exchange - リクエストが送信されるデフォルトの交換。
      routingKey - デフォルトのルーティングキー。
      replyQueue - 応答をリッスンする応答キューの名前。
      replyAddress - 返信アドレス（exchange/routingKey）。

    • AsyncRabbitTemplate

      public AsyncRabbitTemplate(RabbitTemplate template, AbstractMessageListenerContainer container)
      提供された引数を使用してインスタンスを構築します。コンテナーがリッスンするように構成されている最初のキューは、応答キューとして使用されます。返信は、ルーティングキーとしてそのキュー名を持つデフォルトの交換を使用してルーティングされます。
      パラメーター:
      template - RabbitTemplate
      container - AbstractMessageListenerContainer。

    • AsyncRabbitTemplate

      public AsyncRabbitTemplate(RabbitTemplate template, AbstractMessageListenerContainer container, @Nullable StringSE replyAddress)
      指定された引数を使用してインスタンスを構築します。コンテナーがリッスンするように構成されている最初のキューが、応答キューとして使用されます。'replyAddress' が null の場合、応答は、そのキュー名をルーティングキーとして、デフォルトの exchange を使用してルーティングされます。それ以外の場合は、exchange/routingKey の形式を持ち、メッセージが応答キューにルーティングされるようにする必要があります。
      パラメーター:
      template - RabbitTemplate。
      container - AbstractMessageListenerContainer。
      replyAddress - 返信アドレス。

    • AsyncRabbitTemplate

      public AsyncRabbitTemplate(ConnectionFactory connectionFactory, @Nullable StringSE exchange, StringSE routingKey)
      指定された引数を使用してインスタンスを構築します。応答には "Direct replyTo" が使用されます。
      パラメーター:
      connectionFactory - 接続ファクトリ。
      exchange - リクエストが送信されるデフォルトの交換。
      routingKey - デフォルトのルーティングキー。
      導入:
      2.0

    • AsyncRabbitTemplate

      public AsyncRabbitTemplate(RabbitTemplate template)
      指定された引数を使用してインスタンスを構築します。応答には "Direct replyTo" が使用されます。
      パラメーター:
      template - RabbitTemplate
      導入:
      2.0

  • メソッドの詳細

    • setAutoStartup

      public void setAutoStartup(boolean autoStartup)
      パラメーター:
      autoStartup - 自動開始の場合は true。
      関連事項:

    • setPhase

      public void setPhase(int phase)
      パラメーター:
      phase - フェーズ。
      関連事項:

    • setMandatory

      public void setMandatory(boolean mandatory)
      AmqpMessageReturnedException の形式で配信できない返されたメッセージの受信を有効にするには、true に設定します。
      パラメーター:
      mandatory - return を有効にする場合は true。

    • setMandatoryExpression

      public void setMandatoryExpression(Expression mandatoryExpression)
      パラメーター:
      mandatoryExpression - 各リクエストメッセージに対して評価する SpEL Expression。評価の結果は、boolean 値でなければなりません。
      導入:
      2.0

    • setMandatoryExpressionString

      public void setMandatoryExpressionString(StringSE mandatoryExpression)
      パラメーター:
      mandatoryExpression - 各リクエストメッセージに対して評価する SpEL Expression。評価の結果は、boolean 値でなければなりません。
      導入:
      2.0

    • setEnableConfirms

      public void setEnableConfirms(boolean enableConfirms)
      パブリッシャーの確認を有効にするには、true に設定します。有効にすると、送受信操作によって返される RabbitFuture の confirm プロパティに CompletableFuture<Boolean> が含まれます。
      パラメーター:
      enableConfirms - パブリッシャーの確認を有効にする場合は true。

    • getBeanName

      public StringSE getBeanName()

    • setBeanName

      public void setBeanName(StringSE beanName)
      次で指定:
      インターフェース BeanNameAware の setBeanName 

    • getConnectionFactory

      public ConnectionFactory getConnectionFactory()
      戻り値:
      RabbitTemplate 内の基礎となる接続ファクトリへの参照。

    • setReceiveTimeout

      public void setReceiveTimeout(long receiveTimeout)
      受信タイムアウトを設定します。このタイムアウトが期限切れになると、send および receive メソッドによって返される未来はキャンセルされます。<= 0 は、先物が期限切れにならないことを意味します。応答が受信されない場合、これによりメモリリークが発生することに注意してください。デフォルト: 30000 (30 秒)。
      パラメーター:
      receiveTimeout - ミリ秒単位のタイムアウト。

    • setTaskScheduler

      public void setTaskScheduler(TaskScheduler taskScheduler)
      タスクスケジューラを設定して、タイムアウトした先物を期限切れにします。
      パラメーター:
      taskScheduler - タスクスケジューラ
      関連事項:

    • getMessageConverter

      public MessageConverter getMessageConverter()
      戻り値:
      基礎となる RabbitTemplate の MessageConverter への参照。

    • getRabbitTemplate

      public RabbitTemplate getRabbitTemplate()
      送信に使用される基礎となる RabbitTemplate を返します。
      戻り値:
      テンプレート。
      導入:
      2.2

    • sendAndReceive

      public RabbitMessageFuture sendAndReceive(Message message)
      インターフェースからコピーされた説明: AsyncAmqpTemplate
      デフォルトのルーティングキーを使用して、デフォルトの交換にメッセージを送信します。メッセージに correlationId プロパティが含まれている場合、そのプロパティは一意である必要があります。
      次で指定:
      インターフェース AsyncAmqpTemplate の sendAndReceive 
      パラメーター:
      message - メッセージ。
      戻り値:
      CompletableFutureSE

    • sendAndReceive

      public RabbitMessageFuture sendAndReceive(@Nullable StringSE routingKey, Message message)
      インターフェースからコピーされた説明: AsyncAmqpTemplate
      指定されたルーティングキーを使用して、デフォルトの交換にメッセージを送信します。メッセージに correlationId プロパティが含まれている場合、そのプロパティは一意である必要があります。
      次で指定:
      インターフェース AsyncAmqpTemplate の sendAndReceive 
      パラメーター:
      routingKey - ルーティングキー。
      message - メッセージ。
      戻り値:
      CompletableFutureSE

    • sendAndReceive

      public RabbitMessageFuture sendAndReceive(@Nullable StringSE exchange, @Nullable StringSE routingKey, Message message)
      インターフェースからコピーされた説明: AsyncAmqpTemplate
      指定された交換とルーティングキーにメッセージを送信します。メッセージに correlationId プロパティが含まれている場合、そのプロパティは一意である必要があります。
      次で指定:
      インターフェース AsyncAmqpTemplate の sendAndReceive 
      パラメーター:
      exchange - 交換。
      routingKey - ルーティングキー。
      message - メッセージ。
      戻り値:
      CompletableFutureSE

    • convertSendAndReceive

      public <C> RabbitConverterFuture<C> convertSendAndReceive(ObjectSE object)
      インターフェースからコピーされた説明: AsyncAmqpTemplate
      オブジェクトをメッセージに変換し、デフォルトのルーティングキーを使用してデフォルトの交換に送信します。
      次で指定:
      インターフェース AsyncAmqpTemplate の convertSendAndReceive 
      型パラメーター:
      C - 期待される結果型。
      パラメーター:
      object - 変換するオブジェクト。
      戻り値:
      CompletableFutureSE

    • convertSendAndReceive

      public <C> RabbitConverterFuture<C> convertSendAndReceive(@Nullable StringSE routingKey, ObjectSE object)
      インターフェースからコピーされた説明: AsyncAmqpTemplate
      オブジェクトをメッセージに変換し、指定されたルーティングキーを使用してデフォルトの交換に送信します。
      次で指定:
      インターフェース AsyncAmqpTemplate の convertSendAndReceive 
      型パラメーター:
      C - 期待される結果型。
      パラメーター:
      routingKey - ルーティングキー。
      object - 変換するオブジェクト。
      戻り値:
      CompletableFutureSE

    • convertSendAndReceive

      public <C> RabbitConverterFuture<C> convertSendAndReceive(@Nullable StringSE exchange, @Nullable StringSE routingKey, ObjectSE object)
      インターフェースからコピーされた説明: AsyncAmqpTemplate
      オブジェクトをメッセージに変換し、指定された交換およびルーティングキーに送信します。
      次で指定:
      インターフェース AsyncAmqpTemplate の convertSendAndReceive 
      型パラメーター:
      C - 期待される結果型。
      パラメーター:
      exchange - 交換。
      routingKey - ルーティングキー。
      object - 変換するオブジェクト。
      戻り値:
      CompletableFutureSE

    • convertSendAndReceive

      public <C> RabbitConverterFuture<C> convertSendAndReceive(ObjectSE object, MessagePostProcessor messagePostProcessor)
      インターフェースからコピーされた説明: AsyncAmqpTemplate
      MessagePostProcessor を呼び出した後、オブジェクトをメッセージに変換し、デフォルトのルーティングキーを使用してデフォルトのエクスチェンジに送信します。ポストプロセッサーが correlationId プロパティを追加する場合、そのプロパティは一意である必要があります。
      次で指定:
      インターフェース AsyncAmqpTemplate の convertSendAndReceive 
      型パラメーター:
      C - 期待される結果型。
      パラメーター:
      object - 変換するオブジェクト。
      messagePostProcessor - ポストプロセッサー。
      戻り値:
      CompletableFutureSE

    • convertSendAndReceive

      public <C> RabbitConverterFuture<C> convertSendAndReceive(@Nullable StringSE routingKey, ObjectSE object, MessagePostProcessor messagePostProcessor)
      インターフェースからコピーされた説明: AsyncAmqpTemplate
      オブジェクトをメッセージに変換し、MessagePostProcessor を呼び出した後、指定されたルーティングキーを使用してデフォルトのエクスチェンジに送信します。ポストプロセッサーが correlationId プロパティを追加する場合、そのプロパティは一意である必要があります。
      次で指定:
      インターフェース AsyncAmqpTemplate の convertSendAndReceive 
      型パラメーター:
      C - 期待される結果型。
      パラメーター:
      routingKey - ルーティングキー。
      object - 変換するオブジェクト。
      messagePostProcessor - ポストプロセッサー。
      戻り値:
      CompletableFutureSE

    • convertSendAndReceive

      public <C> RabbitConverterFuture<C> convertSendAndReceive(@Nullable StringSE exchange, @Nullable StringSE routingKey, ObjectSE object, @Nullable MessagePostProcessor messagePostProcessor)
      インターフェースからコピーされた説明: AsyncAmqpTemplate
      オブジェクトをメッセージに変換し、MessagePostProcessor を呼び出した後、指定された交換およびルーティングキーに送信します。ポストプロセッサーが correlationId プロパティを追加する場合、そのプロパティは一意である必要があります。
      次で指定:
      インターフェース AsyncAmqpTemplate の convertSendAndReceive 
      型パラメーター:
      C - 期待される結果型。
      パラメーター:
      exchange - 交換
      routingKey - ルーティングキー。
      object - 変換するオブジェクト。
      messagePostProcessor - ポストプロセッサー。
      戻り値:
      CompletableFutureSE

    • convertSendAndReceiveAsType

      public <C> RabbitConverterFuture<C> convertSendAndReceiveAsType(ObjectSE object, ParameterizedTypeReference<C> responseType)
      インターフェースからコピーされた説明: AsyncAmqpTemplate
      オブジェクトをメッセージに変換し、デフォルトのルーティングキーを使用してデフォルトの交換に送信します。
      次で指定:
      インターフェース AsyncAmqpTemplate の convertSendAndReceiveAsType 
      型パラメーター:
      C - 期待される結果型。
      パラメーター:
      object - 変換するオブジェクト。
      responseType - レスポンス型。
      戻り値:
      CompletableFutureSE

    • convertSendAndReceiveAsType

      public <C> RabbitConverterFuture<C> convertSendAndReceiveAsType(@Nullable StringSE routingKey, ObjectSE object, ParameterizedTypeReference<C> responseType)
      インターフェースからコピーされた説明: AsyncAmqpTemplate
      オブジェクトをメッセージに変換し、指定されたルーティングキーを使用してデフォルトの交換に送信します。
      次で指定:
      インターフェース AsyncAmqpTemplate の convertSendAndReceiveAsType 
      型パラメーター:
      C - 期待される結果型。
      パラメーター:
      routingKey - ルーティングキー。
      object - 変換するオブジェクト。
      responseType - レスポンス型。
      戻り値:
      CompletableFutureSE

    • convertSendAndReceiveAsType

      public <C> RabbitConverterFuture<C> convertSendAndReceiveAsType(@Nullable StringSE exchange, @Nullable StringSE routingKey, ObjectSE object, ParameterizedTypeReference<C> responseType)
      インターフェースからコピーされた説明: AsyncAmqpTemplate
      オブジェクトをメッセージに変換し、指定された交換およびルーティングキーに送信します。
      次で指定:
      インターフェース AsyncAmqpTemplate の convertSendAndReceiveAsType 
      型パラメーター:
      C - 期待される結果型。
      パラメーター:
      exchange - 交換。
      routingKey - ルーティングキー。
      object - 変換するオブジェクト。
      responseType - レスポンス型。
      戻り値:
      CompletableFutureSE

    • convertSendAndReceiveAsType

      public <C> RabbitConverterFuture<C> convertSendAndReceiveAsType(ObjectSE object, @Nullable MessagePostProcessor messagePostProcessor, @Nullable ParameterizedTypeReference<C> responseType)
      インターフェースからコピーされた説明: AsyncAmqpTemplate
      MessagePostProcessor を呼び出した後、オブジェクトをメッセージに変換し、デフォルトのルーティングキーを使用してデフォルトのエクスチェンジに送信します。ポストプロセッサーが correlationId プロパティを追加する場合、そのプロパティは一意である必要があります。
      次で指定:
      インターフェース AsyncAmqpTemplate の convertSendAndReceiveAsType 
      型パラメーター:
      C - 期待される結果型。
      パラメーター:
      object - 変換するオブジェクト。
      messagePostProcessor - ポストプロセッサー。
      responseType - レスポンス型。
      戻り値:
      CompletableFutureSE

    • convertSendAndReceiveAsType

      public <C> RabbitConverterFuture<C> convertSendAndReceiveAsType(@Nullable StringSE routingKey, ObjectSE object, @Nullable MessagePostProcessor messagePostProcessor, @Nullable ParameterizedTypeReference<C> responseType)
      インターフェースからコピーされた説明: AsyncAmqpTemplate
      オブジェクトをメッセージに変換し、MessagePostProcessor を呼び出した後、指定されたルーティングキーを使用してデフォルトのエクスチェンジに送信します。ポストプロセッサーが correlationId プロパティを追加する場合、そのプロパティは一意である必要があります。
      次で指定:
      インターフェース AsyncAmqpTemplate の convertSendAndReceiveAsType 
      型パラメーター:
      C - 期待される結果型。
      パラメーター:
      routingKey - ルーティングキー。
      object - 変換するオブジェクト。
      messagePostProcessor - ポストプロセッサー。
      responseType - レスポンス型。
      戻り値:
      CompletableFutureSE

    • convertSendAndReceiveAsType

      public <C> RabbitConverterFuture<C> convertSendAndReceiveAsType(@Nullable StringSE exchange, @Nullable StringSE routingKey, ObjectSE object, @Nullable MessagePostProcessor messagePostProcessor, @Nullable ParameterizedTypeReference<C> responseType)
      インターフェースからコピーされた説明: AsyncAmqpTemplate
      オブジェクトをメッセージに変換し、MessagePostProcessor を呼び出した後、指定された交換およびルーティングキーに送信します。ポストプロセッサーが correlationId プロパティを追加する場合、そのプロパティは一意である必要があります。
      次で指定:
      インターフェース AsyncAmqpTemplate の convertSendAndReceiveAsType 
      型パラメーター:
      C - 期待される結果型。
      パラメーター:
      exchange - 交換
      routingKey - ルーティングキー。
      object - 変換するオブジェクト。
      messagePostProcessor - ポストプロセッサー。
      responseType - レスポンス型。
      戻り値:
      CompletableFutureSE

    • start

      public void start()
      次で指定:
      インターフェース Lifecycle の start 

    • stop

      public void stop()
      次で指定:
      インターフェース Lifecycle の stop 

    • isRunning

      public boolean isRunning()
      次で指定:
      インターフェース Lifecycle の isRunning 

    • getPhase

      public int getPhase()
      次で指定:
      インターフェース Phased の getPhase 
      次で指定:
      インターフェース SmartLifecycle の getPhase 

    • isAutoStartup

      public boolean isAutoStartup()
      次で指定:
      インターフェース SmartLifecycle の isAutoStartup 

    • onMessage

      public void onMessage(Message message, @Nullable com.rabbitmq.client.Channel channel)
      インターフェースからコピーされた説明: ChannelAwareMessageListener
      受信した Rabbit メッセージを処理するためのコールバック。

      実装者は、指定されたメッセージを処理し、通常、指定されたセッションを介して応答メッセージを送信します。

      次で指定:
      インターフェース ChannelAwareMessageListener の onMessage 
      パラメーター:
      message - 受信した AMQP メッセージ (非 null)
      channel - 基盤となる Rabbit チャネル (ストリームリスナーコンテナーによって呼び出されない限り、null ではありません)。

    • returnedMessage

      public void returnedMessage(ReturnedMessage returned)
      インターフェースからコピーされた説明: RabbitTemplate.ReturnsCallback
      返されたメッセージコールバック。
      次で指定:
      インターフェース RabbitTemplate.ReturnsCallback の returnedMessage 
      パラメーター:
      returned - 返されたメッセージとメタデータ。

    • confirm

      public void confirm(@Nullable CorrelationData correlationData, boolean ack, @Nullable StringSE cause)
      インターフェースからコピーされた説明: RabbitTemplate.ConfirmCallback
      確認のコールバック。
      次で指定:
      インターフェース RabbitTemplate.ConfirmCallback の confirm 
      パラメーター:
      correlationData - コールバックの相関データ。
      ack - ack の場合は true、nack の場合は false
      cause - オプションの原因。nack の場合は利用可能な場合、それ以外の場合は null。

    • toString

      public StringSE toString()
      オーバーライド:
      クラス ObjectSE の toString