クラス SubscriptionMethodReturnValueHandler

java.lang.ObjectSE
org.springframework.messaging.simp.annotation.support.SubscriptionMethodReturnValueHandler
実装済みのインターフェース一覧:
HandlerMethodReturnValueHandler
public class SubscriptionMethodReturnValueHandler extends ObjectSE implements HandlerMethodReturnValueHandler
サブスクリプションに直接返信するための HandlerMethodReturnValueHandler。SubscribeMapping アノテーションが付けられたメソッドでサポートされているため、戻り値はセッションで直接返送されるレスポンスとして扱われます。これにより、クライアントはリクエスト / レスポンスパターンを実装し、それを使用して、たとえば初期化時にデータを取得できます。

メソッドから返された値は変換され、Message に変換され、その後、入力メッセージの sessionId、subscriptionId、宛先が追加されます。

注意 : @SubscribeMapping メソッドからの戻り値を解釈するためのこのデフォルトの動作は、SendTo または SendToUser アノテーションを使用してオーバーライドできます。この場合、メッセージが準備され、代わりにブローカーに送信されます。

導入:
4.0
作成者:
Rossen Stoyanchev, Sebastien Deleuze

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

    • SubscriptionMethodReturnValueHandler

      public SubscriptionMethodReturnValueHandler(MessageSendingOperations<StringSE> template)
      新しい SubscriptionMethodReturnValueHandler を作成します。
      パラメーター:
      template - メッセージを送信するためのメッセージングテンプレート (おそらく "clientOutboundChannel" ) (null であってはなりません)

  • 方法の詳細

    • setHeaderInitializer

      public void setHeaderInitializer(@Nullable MessageHeaderInitializer headerInitializer)
      MessageHeaderInitializer を構成して、クライアント送信チャネルに送信されるすべてのメッセージのヘッダーに適用します。

      デフォルトでは、このプロパティは設定されていません。

    • getHeaderInitializer

      public @Nullable MessageHeaderInitializer getHeaderInitializer()
      設定済みのヘッダー初期化子を返します。

    • addHeaderFilter

      public void addHeaderFilter(PredicateSE<StringSE> filter)
      入力メッセージのどのヘッダーを出力メッセージに伝播するかを決定するフィルターを追加します。このフィルターは「ネイティブヘッダー」サブマップに適用されます。複数のフィルターは Predicate.or(Predicate)SE で組み合わせられます。

      デフォルトでは、これが設定されていない場合、ヘッダーは伝播されません。

      導入:
      7.0.4

    • getHeaderFilter

      public @Nullable PredicateSE<StringSE> getHeaderFilter()
      設定されたヘッダーフィルターを返します。
      導入:
      7.0.4

    • supportsReturnType

      public boolean supportsReturnType(MethodParameter returnType)
      インターフェースからコピーされた説明: HandlerMethodReturnValueHandler
      指定されたメソッドの戻り型がこのハンドラーでサポートされているかどうか。
      次で指定:
      インターフェース HandlerMethodReturnValueHandler の supportsReturnType 
      パラメーター:
      returnType - チェックするメソッドの戻り値の型
      戻り値:
      このハンドラーが提供された戻り値の型をサポートする場合、true。それ以外の場合は false 

    • handleReturnValue

      public void handleReturnValue(@Nullable ObjectSE returnValue, MethodParameter returnType, Message<?> message) throws ExceptionSE
      インターフェースからコピーされた説明: HandlerMethodReturnValueHandler
      指定された戻り値を処理します。
      次で指定:
      インターフェース HandlerMethodReturnValueHandler の handleReturnValue 
      パラメーター:
      returnValue - ハンドラーメソッドから返された値
      returnType - 戻り値の型。この型は以前に HandlerMethodReturnValueHandler.supportsReturnType(org.springframework.core.MethodParameter) に渡されていて、true を返している必要があります。
      message - このメソッドが呼び出される原因となったメッセージ
      例外:
      ExceptionSE - 戻り値の処理がエラーになる場合