Package org.springframework.integration.mqtt.support

Class MqttHeaderMapper

java.lang.Object
org.springframework.integration.mqtt.support.MqttHeaderMapper
All Implemented Interfaces:
HeaderMapper<org.eclipse.paho.mqttv5.common.packet.MqttProperties>
@Deprecated(since="7.2", forRemoval=true) public class MqttHeaderMapper extends Object implements HeaderMapper<org.eclipse.paho.mqttv5.common.packet.MqttProperties>
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.
The default HeaderMapper implementation for MQTT v5 message properties mapping.
Since:
5.5.5
Author:
Artem Bilan, Jaehong Park

  • Constructor Summary

    Constructors
    Constructor
    Description
    MqttHeaderMapper()
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    fromHeaders(MessageHeaders headers, org.eclipse.paho.mqttv5.common.packet.MqttProperties target)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setInboundHeaderNames(String... inboundHeaderNames)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Provide a list of patterns to map MQTT message properties into message headers.
    void
    setOutboundHeaderNames(String... outboundHeaderNames)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Provide a list of patterns to map header into a PUBLISH MQTT message.
    Map<String,Object>
    toHeaders(org.eclipse.paho.mqttv5.common.packet.MqttProperties source)
    Deprecated, for removal: This API element is subject to removal in a future version.
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • MqttHeaderMapper

      public MqttHeaderMapper()
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • setInboundHeaderNames

      public void setInboundHeaderNames(String... inboundHeaderNames)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Provide a list of patterns to map MQTT message properties into message headers. By default, it maps all valid MQTT PUBLISH packet headers (see MqttPublish), including all the user properties.
      Parameters:
      inboundHeaderNames - the MQTT message property patterns to map.

    • setOutboundHeaderNames

      public void setOutboundHeaderNames(String... outboundHeaderNames)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Provide a list of patterns to map header into a PUBLISH MQTT message. Default headers are: MessageHeaders.CONTENT_TYPE, MqttHeaders.MESSAGE_EXPIRY_INTERVAL, MqttHeaders.RESPONSE_TOPIC, MqttHeaders.CORRELATION_DATA.
      Parameters:
      outboundHeaderNames - the header patterns to map.

    • fromHeaders

      public void fromHeaders(MessageHeaders headers, org.eclipse.paho.mqttv5.common.packet.MqttProperties target)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      fromHeaders in interface HeaderMapper<org.eclipse.paho.mqttv5.common.packet.MqttProperties>

    • toHeaders

      public Map<String,Object> toHeaders(org.eclipse.paho.mqttv5.common.packet.MqttProperties source)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      toHeaders in interface HeaderMapper<org.eclipse.paho.mqttv5.common.packet.MqttProperties>