org.springframework.integration.mqtt.support

Class DefaultPahoMessageConverter

java.lang.Object

org.springframework.integration.mqtt.support.DefaultPahoMessageConverter

All Implemented Interfaces:

Aware, BeanFactoryAware, MqttMessageConverter, MessageConverter

public class DefaultPahoMessageConverter
extends Object
implements MqttMessageConverter, BeanFactoryAware

Default implementation for mapping to/from Messages.

Since:

4.0

Author:

Gary Russell

Constructor Summary

Constructors

Constructor and Description
DefaultPahoMessageConverter()
DefaultPahoMessageConverter(int defaultQos, boolean defaultRetain)
DefaultPahoMessageConverter(int defaultQos, boolean defaultRetained, String charset)

Method Summary

Methods

Modifier and Type	Method and Description
org.eclipse.paho.client.mqttv3.MqttMessage	fromMessage(Message<?> message, Class<?> targetClass)
protected BeanFactory	getBeanFactory()
protected MessageBuilderFactory	getMessageBuilderFactory()
protected byte[]	messageToMqttBytes(Message<?> message) Subclasses can override this method to convert the payload to a byte[].
protected Object	mqttBytesToPayload(org.eclipse.paho.client.mqttv3.MqttMessage mqttMessage) Subclasses can override this method to convert the byte[] to a payload.
void	setBeanFactory(BeanFactory beanFactory)
protected void	setPayloadAsBytes(boolean payloadAsBytes) True if the converter should not convert the message payload to a String.
Message<?>	toMessage(Object mqttMessage, MessageHeaders headers)
Message<?>	toMessage(String topic, org.eclipse.paho.client.mqttv3.MqttMessage mqttMessage) Convert to a Message.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPahoMessageConverter

public DefaultPahoMessageConverter()

DefaultPahoMessageConverter

public DefaultPahoMessageConverter(int defaultQos,
                           boolean defaultRetain)

DefaultPahoMessageConverter

public DefaultPahoMessageConverter(int defaultQos,
                           boolean defaultRetained,
                           String charset)

Method Detail

setBeanFactory

public final void setBeanFactory(BeanFactory beanFactory)

Specified by:

setBeanFactory in interface BeanFactoryAware

getBeanFactory

protected BeanFactory getBeanFactory()

getMessageBuilderFactory

protected MessageBuilderFactory getMessageBuilderFactory()

setPayloadAsBytes

protected final void setPayloadAsBytes(boolean payloadAsBytes)

True if the converter should not convert the message payload to a String.

Parameters:

payloadAsBytes - The payloadAsBytes to set.

toMessage

public Message<?> toMessage(Object mqttMessage,
                   MessageHeaders headers)

Specified by:

toMessage in interface MessageConverter

toMessage

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

Description copied from interface: MqttMessageConverter

Convert to a Message.

Specified by:

toMessage in interface MqttMessageConverter

Parameters:

topic - The topic.

mqttMessage - The MQTT message.

Returns:

The Message.

fromMessage

public org.eclipse.paho.client.mqttv3.MqttMessage fromMessage(Message<?> message,
                                                     Class<?> targetClass)

Specified by:

fromMessage in interface MessageConverter

mqttBytesToPayload

protected Object mqttBytesToPayload(org.eclipse.paho.client.mqttv3.MqttMessage mqttMessage)
                             throws Exception

Subclasses can override this method to convert the byte[] to a payload. The default implementation creates a String (default) or byte[].

Parameters:

mqttMessage - The inbound message.

Returns:

The payload for the Spring integration message

Throws:

Exception - Any.

messageToMqttBytes

protected byte[] messageToMqttBytes(Message<?> message)

Subclasses can override this method to convert the payload to a byte[]. The default implementation accepts a byte[] or String payload.

Parameters:

message - The outbound Message.

Returns:

The byte[] which will become the payload of the MQTT Message.