org.springframework.integration.mqtt.support

Interface MqttMessageConverter

All Superinterfaces:

MessageConverter

All Known Implementing Classes:

DefaultPahoMessageConverter

public interface MqttMessageConverter
extends MessageConverter

Extension of MessageConverter allowing the topic to be added as a header.

Since:

4.0

Author:

Gary Russell, Artem Bilan

Method Summary

Modifier and Type	Method and Description
static MessageProcessor<Integer>	defaultQosProcessor()
static MessageProcessor<Boolean>	defaultRetainedProcessor()
Message<?>	toMessage(String topic, org.eclipse.paho.client.mqttv3.MqttMessage mqttMessage) Convert to a Message.
default AbstractIntegrationMessageBuilder<?>	toMessageBuilder(String topic, org.eclipse.paho.client.mqttv3.MqttMessage mqttMessage) Convert to a message builder.

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

fromMessage, toMessage

Method Detail

toMessage

Message<?> toMessage(String topic,
                     org.eclipse.paho.client.mqttv3.MqttMessage mqttMessage)

Convert to a Message.

Parameters:

topic - the topic.

mqttMessage - the MQTT message.

Returns:

the Message.

toMessageBuilder

default AbstractIntegrationMessageBuilder<?> toMessageBuilder(String topic,
                                                              org.eclipse.paho.client.mqttv3.MqttMessage mqttMessage)

Convert to a message builder. This method is default with a delegation to the toMessage(String, MqttMessage) to avoid a breaking change for migrated projects. The delegation will be swapped in the next version.

Parameters:

topic - the topic.

mqttMessage - the MQTT message.

Returns:

the builder.

defaultQosProcessor

static MessageProcessor<Integer> defaultQosProcessor()

defaultRetainedProcessor

static MessageProcessor<Boolean> defaultRetainedProcessor()