クラス SendToMethodReturnValueHandler

java.lang.ObjectSE
org.springframework.messaging.simp.annotation.support.SendToMethodReturnValueHandler
実装されたすべてのインターフェース:
HandlerMethodReturnValueHandler

public class SendToMethodReturnValueHandler extends ObjectSE implements HandlerMethodReturnValueHandler
SendTo または SendToUser メソッドレベルのアノテーションで指定された宛先に送信するための HandlerMethodReturnValueHandler

メソッドから返された値は変換され、Message に変換され、提供された MessageChannel を介して送信されます。メッセージは、入力メッセージのセッション ID とアノテーションからの宛先で強化されます。複数の宛先が指定されている場合、メッセージのコピーが各宛先に送信されます。

導入:
4.0
作成者:
Rossen Stoyanchev, Sebastien Deleuze
  • コンストラクターの詳細

    • SendToMethodReturnValueHandler

      public SendToMethodReturnValueHandler(SimpMessageSendingOperations messagingTemplate, boolean annotationRequired)
  • メソッドの詳細

    • setDefaultDestinationPrefix

      public void setDefaultDestinationPrefix(StringSE defaultDestinationPrefix)
      メソッドに @SendTo アノテーションが付けられていない場合、またはアノテーションの value 属性で宛先が指定されていない場合に、メッセージの宛先に追加するデフォルトのプレフィックスを構成します。

      デフォルトでは、プレフィックスは "/topic" に設定されています。

    • getDefaultDestinationPrefix

      public StringSE getDefaultDestinationPrefix()
      設定されたデフォルトの宛先プレフィックスを返します。
      関連事項:
    • setDefaultUserDestinationPrefix

      public void setDefaultUserDestinationPrefix(StringSE prefix)
      メソッドに @SendToUser アノテーションが付けられているが、アノテーションの value 属性を通じて宛先が指定されていない場合に、メッセージの宛先に追加するデフォルトのプレフィックスを設定します。

      デフォルトでは、プレフィックスは "/queue" に設定されています。

    • getDefaultUserDestinationPrefix

      public StringSE getDefaultUserDestinationPrefix()
      設定されたデフォルトのユーザー宛先プレフィックスを返します。
      関連事項:
    • setHeaderInitializer

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

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

    • getHeaderInitializer

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

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

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

      @Nullable protected StringSE getUserName(Message<?> message, MessageHeaders headers)
    • getTargetDestinations

      protected StringSE[] getTargetDestinations(@Nullable AnnotationSE annotation, Message<?> message, StringSE defaultPrefix)
    • toString

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