Package org.apache.activemq.artemis.core.protocol.mqtt

Class MQTTUtil

java.lang.Object

org.apache.activemq.artemis.core.protocol.mqtt.MQTTUtil

public class MQTTUtil
extends Object

A Utility Class for creating Server Side objects and converting MQTT concepts to/from Artemis.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MQTTUtil.MQTTWildcardConfiguration

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_MAXIMUM_PACKET_SIZE
static int	DEFAULT_RECEIVE_MAXIMUM
static int	DEFAULT_SERVER_KEEP_ALIVE
static int	DEFAULT_TOPIC_ALIAS_MAX
static char	DOLLAR
static boolean	DURABLE_MESSAGES
static long	FOUR_BYTE_INT_MAX
static char	HASH
static long	KEEP_ALIVE_ADJUSTMENT
static String	MANAGEMENT_QUEUE_PREFIX
static int	MAX_PACKET_SIZE
static SimpleString	MQTT_CONTENT_TYPE_KEY
static SimpleString	MQTT_CORRELATION_DATA_KEY
static SimpleString	MQTT_MESSAGE_ID_KEY
static SimpleString	MQTT_MESSAGE_RETAIN_INITIAL_DISTRIBUTION_KEY
static SimpleString	MQTT_MESSAGE_RETAIN_KEY
static SimpleString	MQTT_MESSAGE_TYPE_KEY
static SimpleString	MQTT_PAYLOAD_FORMAT_INDICATOR_KEY
static SimpleString	MQTT_QOS_LEVEL_KEY
static SimpleString	MQTT_RESPONSE_TOPIC_KEY
static String	MQTT_RETAIN_ADDRESS_PREFIX
static String	MQTT_SESSION_STORE
static String	MQTT_USER_PROPERTY_EXISTS_KEY
static String	MQTT_USER_PROPERTY_KEY_PREFIX
static SimpleString	MQTT_USER_PROPERTY_KEY_PREFIX_SIMPLE
static WildcardConfiguration	MQTT_WILDCARD
static char	PLUS
static boolean	SESSION_AUTO_COMMIT_ACKS
static boolean	SESSION_AUTO_COMMIT_SENDS
static boolean	SESSION_AUTO_CREATE_QUEUE
static boolean	SESSION_PREACKNOWLEDGE
static boolean	SESSION_XA
static String	SHARED_SUBSCRIPTION_PREFIX
static char	SLASH
static int	TWO_BYTE_INT_MAX
static int	VARIABLE_BYTE_INT_MAX

Constructor Summary

Constructors

Constructor	Description
MQTTUtil()

Method Summary

Modifier and Type	Method	Description
static int	calculateMessageSize(io.netty.handler.codec.mqtt.MqttPublishMessage message)
static int	calculateRemainingLength(String topicName, io.netty.handler.codec.mqtt.MqttProperties properties, io.netty.buffer.ByteBuf payload)
static String	convertCoreAddressToMqttTopicFilter(String address, WildcardConfiguration wildcardConfiguration)
static String	convertMqttTopicFilterToCoreAddress(String prefixToAdd, String filter, WildcardConfiguration wildcardConfiguration)
static String	convertMqttTopicFilterToCoreAddress(String filter, WildcardConfiguration wildcardConfiguration)
static Message	createPubRelMessage(MQTTSession session, SimpleString address, int messageId)
static Message	createServerMessageFromByteBuf(MQTTSession session, SimpleString address, io.netty.handler.codec.mqtt.MqttPublishMessage mqttPublishMessage)
static <T> T	getProperty(Class<T> type, io.netty.handler.codec.mqtt.MqttProperties properties, io.netty.handler.codec.mqtt.MqttProperties.MqttPropertyType propertyName)
static <T> T	getProperty(Class<T> type, io.netty.handler.codec.mqtt.MqttProperties properties, io.netty.handler.codec.mqtt.MqttProperties.MqttPropertyType propertyName, T defaultReturnValue)
static void	logMessage(MQTTSessionState state, io.netty.handler.codec.mqtt.MqttMessage message, boolean inbound, MQTTVersion version)

Methods inherited from class java.lang.Object

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

Field Detail

DURABLE_MESSAGES

public static final boolean DURABLE_MESSAGES

See Also:

Constant Field Values

SESSION_AUTO_COMMIT_SENDS

public static final boolean SESSION_AUTO_COMMIT_SENDS

See Also:

Constant Field Values

SESSION_AUTO_COMMIT_ACKS

public static final boolean SESSION_AUTO_COMMIT_ACKS

See Also:

Constant Field Values

SESSION_PREACKNOWLEDGE

public static final boolean SESSION_PREACKNOWLEDGE

See Also:

Constant Field Values

SESSION_XA

public static final boolean SESSION_XA

See Also:

Constant Field Values

SESSION_AUTO_CREATE_QUEUE

public static final boolean SESSION_AUTO_CREATE_QUEUE

See Also:

Constant Field Values

DOLLAR

public static final char DOLLAR

See Also:

Constant Field Values

HASH

public static final char HASH

See Also:

Constant Field Values

PLUS

public static final char PLUS

See Also:

Constant Field Values

SLASH

public static final char SLASH

See Also:

Constant Field Values

MQTT_SESSION_STORE

public static final String MQTT_SESSION_STORE

See Also:

Constant Field Values

MQTT_RETAIN_ADDRESS_PREFIX

public static final String MQTT_RETAIN_ADDRESS_PREFIX

See Also:

Constant Field Values

MQTT_QOS_LEVEL_KEY

public static final SimpleString MQTT_QOS_LEVEL_KEY

MQTT_MESSAGE_ID_KEY

public static final SimpleString MQTT_MESSAGE_ID_KEY

MQTT_MESSAGE_TYPE_KEY

public static final SimpleString MQTT_MESSAGE_TYPE_KEY

MQTT_MESSAGE_RETAIN_KEY

public static final SimpleString MQTT_MESSAGE_RETAIN_KEY

MQTT_MESSAGE_RETAIN_INITIAL_DISTRIBUTION_KEY

public static final SimpleString MQTT_MESSAGE_RETAIN_INITIAL_DISTRIBUTION_KEY

MQTT_PAYLOAD_FORMAT_INDICATOR_KEY

public static final SimpleString MQTT_PAYLOAD_FORMAT_INDICATOR_KEY

MQTT_RESPONSE_TOPIC_KEY

public static final SimpleString MQTT_RESPONSE_TOPIC_KEY

MQTT_CORRELATION_DATA_KEY

public static final SimpleString MQTT_CORRELATION_DATA_KEY

MQTT_USER_PROPERTY_EXISTS_KEY

public static final String MQTT_USER_PROPERTY_EXISTS_KEY

See Also:

Constant Field Values

MQTT_USER_PROPERTY_KEY_PREFIX

public static final String MQTT_USER_PROPERTY_KEY_PREFIX

See Also:

Constant Field Values

MQTT_USER_PROPERTY_KEY_PREFIX_SIMPLE

public static final SimpleString MQTT_USER_PROPERTY_KEY_PREFIX_SIMPLE

MQTT_CONTENT_TYPE_KEY

public static final SimpleString MQTT_CONTENT_TYPE_KEY

MANAGEMENT_QUEUE_PREFIX

public static final String MANAGEMENT_QUEUE_PREFIX

See Also:

Constant Field Values

SHARED_SUBSCRIPTION_PREFIX

public static final String SHARED_SUBSCRIPTION_PREFIX

See Also:

Constant Field Values

FOUR_BYTE_INT_MAX

public static final long FOUR_BYTE_INT_MAX

TWO_BYTE_INT_MAX

public static final int TWO_BYTE_INT_MAX

VARIABLE_BYTE_INT_MAX

public static final int VARIABLE_BYTE_INT_MAX

See Also:

Constant Field Values

MAX_PACKET_SIZE

public static final int MAX_PACKET_SIZE

See Also:

Constant Field Values

KEEP_ALIVE_ADJUSTMENT

public static final long KEEP_ALIVE_ADJUSTMENT

See Also:

Constant Field Values

DEFAULT_SERVER_KEEP_ALIVE

public static final int DEFAULT_SERVER_KEEP_ALIVE

See Also:

Constant Field Values

DEFAULT_TOPIC_ALIAS_MAX

public static final int DEFAULT_TOPIC_ALIAS_MAX

DEFAULT_RECEIVE_MAXIMUM

public static final int DEFAULT_RECEIVE_MAXIMUM

DEFAULT_MAXIMUM_PACKET_SIZE

public static final int DEFAULT_MAXIMUM_PACKET_SIZE

See Also:

Constant Field Values

MQTT_WILDCARD

public static final WildcardConfiguration MQTT_WILDCARD

Constructor Detail

MQTTUtil

public MQTTUtil()

Method Detail

convertMqttTopicFilterToCoreAddress

public static String convertMqttTopicFilterToCoreAddress(String filter,
                                                         WildcardConfiguration wildcardConfiguration)

convertMqttTopicFilterToCoreAddress

public static String convertMqttTopicFilterToCoreAddress(String prefixToAdd,
                                                         String filter,
                                                         WildcardConfiguration wildcardConfiguration)

convertCoreAddressToMqttTopicFilter

public static String convertCoreAddressToMqttTopicFilter(String address,
                                                         WildcardConfiguration wildcardConfiguration)

createServerMessageFromByteBuf

public static Message createServerMessageFromByteBuf(MQTTSession session,
                                                     SimpleString address,
                                                     io.netty.handler.codec.mqtt.MqttPublishMessage mqttPublishMessage)

createPubRelMessage

public static Message createPubRelMessage(MQTTSession session,
                                          SimpleString address,
                                          int messageId)

logMessage

public static void logMessage(MQTTSessionState state,
                              io.netty.handler.codec.mqtt.MqttMessage message,
                              boolean inbound,
                              MQTTVersion version)

calculateRemainingLength

public static int calculateRemainingLength(String topicName,
                                           io.netty.handler.codec.mqtt.MqttProperties properties,
                                           io.netty.buffer.ByteBuf payload)

calculateMessageSize

public static int calculateMessageSize(io.netty.handler.codec.mqtt.MqttPublishMessage message)

getProperty

public static <T> T getProperty(Class<T> type,
                                io.netty.handler.codec.mqtt.MqttProperties properties,
                                io.netty.handler.codec.mqtt.MqttProperties.MqttPropertyType propertyName)

getProperty

public static <T> T getProperty(Class<T> type,
                                io.netty.handler.codec.mqtt.MqttProperties properties,
                                io.netty.handler.codec.mqtt.MqttProperties.MqttPropertyType propertyName,
                                T defaultReturnValue)