Package org.springframework.integration.mqtt.support

Class MqttHeaderMapper

java.lang.Object
org.springframework.integration.mqtt.support.MqttHeaderMapper
All Implemented Interfaces:
org.springframework.integration.mapping.HeaderMapper<org.eclipse.paho.mqttv5.common.packet.MqttProperties>
public class MqttHeaderMapper
extends java.lang.Object
implements org.springframework.integration.mapping.HeaderMapper<org.eclipse.paho.mqttv5.common.packet.MqttProperties>
The default HeaderMapper implementation for MQTT v5 message properties mapping.
Since:
5.5.5

  • Constructor Summary

    Constructors 
    Constructor Description
    MqttHeaderMapper()  

  • Method Summary

    Modifier and Type Method Description
    void fromHeaders​(org.springframework.messaging.MessageHeaders headers, org.eclipse.paho.mqttv5.common.packet.MqttProperties target)  
    void setInboundHeaderNames​(java.lang.String... inboundHeaderNames)
    Provide a list of patterns to map MQTT message properties into message headers.
    void setOutboundHeaderNames​(java.lang.String... outboundHeaderNames)
    Provide a list of patterns to map header into a PUBLISH MQTT message.
    java.util.Map<java.lang.String,​java.lang.Object> toHeaders​(org.eclipse.paho.mqttv5.common.packet.MqttProperties source)  

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • setInboundHeaderNames

      public void setInboundHeaderNames​(java.lang.String... inboundHeaderNames)
      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​(java.lang.String... outboundHeaderNames)
      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​(org.springframework.messaging.MessageHeaders headers, org.eclipse.paho.mqttv5.common.packet.MqttProperties target)
      Specified by:
      fromHeaders in interface org.springframework.integration.mapping.HeaderMapper<org.eclipse.paho.mqttv5.common.packet.MqttProperties>

    • toHeaders

      public java.util.Map<java.lang.String,​java.lang.Object> toHeaders​(org.eclipse.paho.mqttv5.common.packet.MqttProperties source)
      Specified by:
      toHeaders in interface org.springframework.integration.mapping.HeaderMapper<org.eclipse.paho.mqttv5.common.packet.MqttProperties>