クラス AbstractMessageSendingTemplate<D>

java.lang.ObjectSE
org.springframework.messaging.core.AbstractMessageSendingTemplate<D>
型パラメーター:
D - 宛先型
実装されたすべてのインターフェース:
MessageSendingOperations<D>
既知の直属サブクラス
AbstractMessageReceivingTemplateSimpMessagingTemplate

public abstract class AbstractMessageSendingTemplate<D> extends ObjectSE implements MessageSendingOperations<D>
MessageSendingOperations の実装の抽象基本クラス。
導入:
4.0
作成者:
Mark Fisher, Rossen Stoyanchev, Stephane Nicoll
  • フィールドの詳細

    • CONVERSION_HINT_HEADER

      public static final StringSE CONVERSION_HINT_HEADER
      変換のヒントとして考慮される、ペイロードの発信元に関する詳細情報(MethodParameter インスタンスなど)を提供するように設定できるヘッダーの名前。
      導入:
      4.2
      関連事項:
    • logger

      protected final Log logger
  • コンストラクターの詳細

    • AbstractMessageSendingTemplate

      public AbstractMessageSendingTemplate()
  • メソッドの詳細

    • setDefaultDestination

      public void setDefaultDestination(@Nullable D defaultDestination)
      宛先引数を持たない送信メソッドで使用するデフォルトの宛先を構成します。デフォルトの宛先が構成されていない場合、宛先引数のない send メソッドは、呼び出されると例外を発生させます。
    • getDefaultDestination

      @Nullable public D getDefaultDestination()
      設定されたデフォルトの宛先を返します。
    • setMessageConverter

      public void setMessageConverter(MessageConverter messageConverter)
      MessageConverter を convertAndSend メソッドで使用するように設定します。

      デフォルトでは、SimpleMessageConverter が使用されます。

      パラメーター:
      messageConverter - 使用するメッセージコンバーター
    • getMessageConverter

      public MessageConverter getMessageConverter()
      設定された MessageConverter を返します。
    • send

      public void send(Message<?> message)
      インターフェースからコピーされた説明: MessageSendingOperations
      デフォルトの宛先にメッセージを送信します。
      次で指定:
      インターフェース MessageSendingOperations<D>send 
      パラメーター:
      message - 送信するメッセージ
    • getRequiredDefaultDestination

      protected final D getRequiredDefaultDestination()
    • send

      public void send(D destination, Message<?> message)
      インターフェースからコピーされた説明: MessageSendingOperations
      指定された宛先にメッセージを送信します。
      次で指定:
      インターフェース MessageSendingOperations<D>send 
      パラメーター:
      destination - 宛先
      message - 送信するメッセージ
    • doSend

      protected abstract void doSend(D destination, Message<?> message)
    • convertAndSend

      public void convertAndSend(ObjectSE payload) throws MessagingException
      インターフェースからコピーされた説明: MessageSendingOperations
      おそらく MessageConverter を使用して、指定されたオブジェクトを直列化された形式に変換し、それをメッセージとしてラップし、デフォルトの宛先に送信します。
      次で指定:
      インターフェース MessageSendingOperations<D>convertAndSend 
      パラメーター:
      payload - ペイロードとして使用するオブジェクト
      例外:
      MessagingException
    • convertAndSend

      public void convertAndSend(D destination, ObjectSE payload) throws MessagingException
      インターフェースからコピーされた説明: MessageSendingOperations
      おそらく MessageConverter を使用して、指定されたオブジェクトを直列化された形式に変換し、それをメッセージとしてラップし、指定された宛先に送信します。
      次で指定:
      インターフェース MessageSendingOperations<D>convertAndSend 
      パラメーター:
      destination - 宛先
      payload - ペイロードとして使用するオブジェクト
      例外:
      MessagingException
    • convertAndSend

      public void convertAndSend(D destination, ObjectSE payload, @Nullable MapSE<StringSE,ObjectSE> headers) throws MessagingException
      インターフェースからコピーされた説明: MessageSendingOperations
      おそらく MessageConverter を使用して、指定されたオブジェクトを直列化された形式に変換し、指定されたヘッダーを持つメッセージとしてラップし、指定された宛先に送信します。
      次で指定:
      インターフェース MessageSendingOperations<D>convertAndSend 
      パラメーター:
      destination - 宛先
      payload - ペイロードとして使用するオブジェクト
      headers - 送信するメッセージのヘッダー
      例外:
      MessagingException
    • convertAndSend

      public void convertAndSend(ObjectSE payload, @Nullable MessagePostProcessor postProcessor) throws MessagingException
      インターフェースからコピーされた説明: MessageSendingOperations
      おそらく MessageConverter を使用して、指定されたオブジェクトを直列化された形式に変換し、それをメッセージとしてラップし、指定されたポストプロセッサーを適用し、結果のメッセージをデフォルトの宛先に送信します。
      次で指定:
      インターフェース MessageSendingOperations<D>convertAndSend 
      パラメーター:
      payload - ペイロードとして使用するオブジェクト
      postProcessor - メッセージに適用するポストプロセッサー
      例外:
      MessagingException
    • convertAndSend

      public void convertAndSend(D destination, ObjectSE payload, @Nullable MessagePostProcessor postProcessor) throws MessagingException
      インターフェースからコピーされた説明: MessageSendingOperations
      おそらく MessageConverter を使用して、指定されたオブジェクトを直列化された形式に変換し、メッセージとしてラップし、指定されたポストプロセッサーを適用して、指定された宛先に結果のメッセージを送信します。
      次で指定:
      インターフェース MessageSendingOperations<D>convertAndSend 
      パラメーター:
      destination - 宛先
      payload - ペイロードとして使用するオブジェクト
      postProcessor - メッセージに適用するポストプロセッサー
      例外:
      MessagingException
    • convertAndSend

      public void convertAndSend(D destination, ObjectSE payload, @Nullable MapSE<StringSE,ObjectSE> headers, @Nullable MessagePostProcessor postProcessor) throws MessagingException
      インターフェースからコピーされた説明: MessageSendingOperations
      おそらく MessageConverter を使用して、指定されたオブジェクトを直列化された形式に変換し、指定されたヘッダーでメッセージとしてラップし、指定されたポストプロセッサーを適用し、結果のメッセージを指定された宛先に送信します。
      次で指定:
      インターフェース MessageSendingOperations<D>convertAndSend 
      パラメーター:
      destination - 宛先
      payload - ペイロードとして使用するオブジェクト
      headers - 送信するメッセージのヘッダー
      postProcessor - メッセージに適用するポストプロセッサー
      例外:
      MessagingException
    • doConvert

      protected Message<?> doConvert(ObjectSE payload, @Nullable MapSE<StringSE,ObjectSE> headers, @Nullable MessagePostProcessor postProcessor)
      おそらく MessageConverter を使用して、指定されたオブジェクトを直列化された形式に変換し、指定されたヘッダーを持つメッセージとしてラップし、指定されたポストプロセッサーを適用します。
      パラメーター:
      payload - ペイロードとして使用するオブジェクト
      headers - 送信するメッセージのヘッダー
      postProcessor - メッセージに適用するポストプロセッサー
      戻り値:
      変換されたメッセージ
    • processHeadersToSend

      @Nullable protected MapSE<StringSE,ObjectSE> processHeadersToSend(@Nullable MapSE<StringSE,ObjectSE> headers)
      送信操作の前に入力ヘッダーのマップへのアクセスを提供します。サブクラスはヘッダーを変更し、同じまたは異なるマップを返すことができます。

      このクラスのこのデフォルト実装は、入力マップを返します。

      パラメーター:
      headers - 送信するヘッダー (または、存在しない場合は null )
      戻り値:
      送信する実際のヘッダー (または、存在しない場合は null )