Package org.springframework.integration.mqtt.support

Interface MqttMessageConverter

All Superinterfaces:
MessageConverter
All Known Implementing Classes:
DefaultPahoMessageConverter
@Deprecated(since="7.2", forRemoval=true) public interface MqttMessageConverter extends MessageConverter
Deprecated, for removal: This API element is subject to removal in a future version.
since 7.2 in favor of the spring-integration-mqtt-client module.
Extension of MessageConverter allowing the topic to be added as a header.
Since:
4.0
Author:
Gary Russell, Artem Bilan, Jaehong Park

  • Method Summary

    Modifier and Type
    Method
    Description
    static MessageProcessor<Integer>
    defaultQosProcessor()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    static MessageProcessor<Boolean>
    defaultRetainedProcessor()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    default @Nullable Message<?>
    toMessage(@Nullable String topic, org.eclipse.paho.client.mqttv3.MqttMessage mqttMessage)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Convert to a Message.
    @Nullable AbstractIntegrationMessageBuilder<?>
    toMessageBuilder(@Nullable String topic, org.eclipse.paho.client.mqttv3.MqttMessage mqttMessage)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Convert to a message builder.

    Methods inherited from interface org.springframework.messaging.converter.MessageConverter

    fromMessage, toMessage

  • Method Details

    • toMessage

      default @Nullable Message<?> toMessage(@Nullable String topic, org.eclipse.paho.client.mqttv3.MqttMessage mqttMessage)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Convert to a Message. The default implementation calls toMessageBuilder(String, MqttMessage).
      Parameters:
      topic - the topic.
      mqttMessage - the MQTT message.
      Returns:
      the Message.

    • toMessageBuilder

      @Nullable AbstractIntegrationMessageBuilder<?> toMessageBuilder(@Nullable String topic, org.eclipse.paho.client.mqttv3.MqttMessage mqttMessage)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Convert to a message builder.
      Parameters:
      topic - the topic.
      mqttMessage - the MQTT message.
      Returns:
      the builder.

    • defaultQosProcessor

      static MessageProcessor<Integer> defaultQosProcessor()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • defaultRetainedProcessor

      static MessageProcessor<Boolean> defaultRetainedProcessor()
      Deprecated, for removal: This API element is subject to removal in a future version.