クラス DefaultPahoMessageConverter

java.lang.ObjectSE
org.springframework.integration.mqtt.support.DefaultPahoMessageConverter
実装済みのインターフェース一覧:
Aware, BeanFactoryAware, MqttMessageConverter, MessageConverter
public class DefaultPahoMessageConverter extends ObjectSE implements MqttMessageConverter, BeanFactoryAware
メッセージとの間でマッピングするためのデフォルトの実装。
導入:
4.0
作成者:
Gary Russell, Artem Bilan

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

    • DefaultPahoMessageConverter

      public DefaultPahoMessageConverter()
      デフォルトのオプション（qos = 0、retain = false、charset = UTF-8）を使用してコンバーターを構築します。

    • DefaultPahoMessageConverter

      public DefaultPahoMessageConverter(int defaultQos, boolean defaultRetained)
      コンバーターを構築して、提供されたデフォルトの QoS を使用して送信メッセージを作成し、設定と、送信文字列ペイロードを byte[] に、受信 byte[] を文字列に変換するための UTF-8 文字セットを保持します（payloadAdBytes が true でない場合）。
      パラメーター:
      defaultQos - デフォルトの QoS。
      defaultRetained - デフォルトは保持されます。

    • DefaultPahoMessageConverter

      public DefaultPahoMessageConverter(StringSE charset)
      デフォルトのオプション（qos = 0、retain = false）と提供された文字セットを使用してコンバーターを構築します。
      パラメーター:
      charset - 送信文字列ペイロードを byte[] に変換し、受信 byte[] を文字列に変換するために使用される文字セット（payloadAdBytes が true の場合を除く）。
      導入:
      4.1.2

    • DefaultPahoMessageConverter

      public DefaultPahoMessageConverter(int defaultQos, boolean defaultRetained, StringSE charset)
      コンバーターを構築して、提供されたデフォルトの QoS を使用して送信メッセージを作成し、設定と提供された文字セットを保持します。
      パラメーター:
      defaultQos - デフォルトの QoS。
      defaultRetained - デフォルトは保持されます。
      charset - 送信文字列ペイロードを byte[] に変換し、受信 byte[] を文字列に変換するために使用される文字セット（payloadAdBytes が true の場合を除く）。

    • DefaultPahoMessageConverter

      public DefaultPahoMessageConverter(int defaultQos, MessageProcessor<IntegerSE> qosProcessor, boolean defaultRetained, MessageProcessor<BooleanSE> retainedProcessor)
      提供されたデフォルトの QoS と保持されたメッセージプロセッサー、および送信文字列ペイロードを byte[] に、受信 byte[] を文字列に変換するための UTF-8 文字セットを使用して送信メッセージを作成するコンバーターを構築します（payloadAdBytes が true でない場合）。
      パラメーター:
      defaultQos - デフォルトの QoS。
      qosProcessor - QOS を決定するためのメッセージプロセッサー。
      defaultRetained - デフォルトは保持されます。
      retainedProcessor - 保持されたフラグを判別するためのメッセージプロセッサー。
      導入:
      5.0

    • DefaultPahoMessageConverter

      public DefaultPahoMessageConverter(int defaultQos, MessageProcessor<IntegerSE> qosProcessor, boolean defaultRetained, MessageProcessor<BooleanSE> retainedProcessor, StringSE charset)
      コンバーターを構築して、提供されたデフォルトの QoS を使用して送信メッセージを作成し、設定と提供された文字セットを保持します。
      パラメーター:
      defaultQos - デフォルトの QoS。
      qosProcessor - QOS を決定するためのメッセージプロセッサー。
      defaultRetained - デフォルトは保持されます。
      retainedProcessor - 保持されたフラグを判別するためのメッセージプロセッサー。
      charset - 送信文字列ペイロードを byte[] に変換し、受信 byte[] を文字列に変換するために使用される文字セット（payloadAdBytes が true の場合を除く）。
      導入:
      5.0

  • 方法の詳細

    • setBeanFactory

      public final void setBeanFactory(BeanFactory beanFactory)
      次で指定:
      インターフェース BeanFactoryAware 内の setBeanFactory 

    • getBeanFactory

      protected BeanFactory getBeanFactory()

    • getMessageBuilderFactory

      protected MessageBuilderFactory getMessageBuilderFactory()

    • setPayloadAsBytes

      public void setPayloadAsBytes(boolean payloadAsBytes)
      コンバーターがメッセージペイロードを文字列に変換してはならない場合は True。BytesMessageMapper が提供されている場合は無視されます。
      パラメーター:
      payloadAsBytes - 設定する payloadAsBytes。
      関連事項:

    • isPayloadAsBytes

      public boolean isPayloadAsBytes()

    • setBytesMessageMapper

      public void setBytesMessageMapper(BytesMessageMapper bytesMessageMapper)
      byte[] をマッピングするときに使用する BytesMessageMapper を設定します。BytesMessageMapper が提供されている場合、setPayloadAsBytes(boolean) は無視されます。
      パラメーター:
      bytesMessageMapper - マッパー。
      導入:
      5.0
      関連事項:

    • toMessage

      public @Nullable Message<?> toMessage(ObjectSE mqttMessage, @Nullable MessageHeaders headers)
      次で指定:
      インターフェース MessageConverter 内の toMessage 

    • toMessageBuilder

      public AbstractIntegrationMessageBuilder<?> toMessageBuilder(@Nullable StringSE topic, org.eclipse.paho.client.mqttv3.MqttMessage mqttMessage)
      インターフェースからコピーされた説明: MqttMessageConverter
      メッセージビルダーに変換します。
      次で指定:
      インターフェース MqttMessageConverter 内の toMessageBuilder 
      パラメーター:
      topic - トピック。
      mqttMessage - MQTT メッセージ。
      戻り値:
      ビルダー。

    • fromMessage

      public org.eclipse.paho.client.mqttv3.MqttMessage fromMessage(Message<?> message, ClassSE<?> targetClass)
      次で指定:
      インターフェース MessageConverter 内の fromMessage 

    • mqttBytesToPayload

      protected ObjectSE mqttBytesToPayload(org.eclipse.paho.client.mqttv3.MqttMessage mqttMessage)
      サブクラスはこのメソッドをオーバーライドして、byte[] をペイロードに変換できます。デフォルトの実装では、String（デフォルト）または byte[] が作成されます。
      パラメーター:
      mqttMessage - 受信メッセージ。
      戻り値:
      Spring 統合メッセージのペイロード

    • messageToMqttBytes

      protected byte[] messageToMqttBytes(Message<?> message)
      サブクラスはこのメソッドをオーバーライドして、ペイロードを byte[] に変換できます。デフォルトの実装は、byte[] または String ペイロードを受け入れます。BytesMessageMapper が提供されている場合、byte[] への変換が委譲されるため、BytesMessageMapper が処理できるすべてのペイロードがサポートされます。
      パラメーター:
      message - 送信メッセージ。
      戻り値:
      MQTT メッセージのペイロードとなる byte[]。