Package io.netty.handler.codec.mqtt

Class MqttProperties

java.lang.Object

io.netty.handler.codec.mqtt.MqttProperties

public final class MqttProperties
extends java.lang.Object

MQTT Properties container

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MqttProperties.BinaryProperty
static class	MqttProperties.IntegerProperty
static class	MqttProperties.MqttProperty<T>	MQTT property base class
static class	MqttProperties.MqttPropertyType	Deprecated.
static class	MqttProperties.StringPair
static class	MqttProperties.StringProperty
static class	MqttProperties.UserProperties
static class	MqttProperties.UserProperty

Field Summary

Fields

Modifier and Type	Field	Description
static int	ASSIGNED_CLIENT_IDENTIFIER
static int	AUTHENTICATION_DATA
static int	AUTHENTICATION_METHOD
private boolean	canModify
static int	CONTENT_TYPE
static int	CORRELATION_DATA
static int	MAXIMUM_PACKET_SIZE
static int	MAXIMUM_QOS
static MqttProperties	NO_PROPERTIES
static int	PAYLOAD_FORMAT_INDICATOR
private IntObjectHashMap<MqttProperties.MqttProperty>	props
static int	PUBLICATION_EXPIRY_INTERVAL
static int	REASON_STRING
static int	RECEIVE_MAXIMUM
static int	REQUEST_PROBLEM_INFORMATION
static int	REQUEST_RESPONSE_INFORMATION
static int	RESPONSE_INFORMATION
static int	RESPONSE_TOPIC
static int	RETAIN_AVAILABLE
static int	SERVER_KEEP_ALIVE
static int	SERVER_REFERENCE
static int	SESSION_EXPIRY_INTERVAL
static int	SHARED_SUBSCRIPTION_AVAILABLE
static int	SUBSCRIPTION_IDENTIFIER
static int	SUBSCRIPTION_IDENTIFIER_AVAILABLE
private java.util.List<MqttProperties.IntegerProperty>	subscriptionIds
static int	TOPIC_ALIAS
static int	TOPIC_ALIAS_MAXIMUM
static int	USER_PROPERTY
private java.util.List<MqttProperties.UserProperty>	userProperties
static int	WILDCARD_SUBSCRIPTION_AVAILABLE
static int	WILL_DELAY_INTERVAL

Constructor Summary

Constructors

Modifier	Constructor	Description
	MqttProperties()
private	MqttProperties(boolean canModify)

Method Summary

Modifier and Type	Method	Description
void	add(MqttProperties.MqttProperty property)
java.util.List<? extends MqttProperties.MqttProperty>	getProperties(int propertyId)	Get properties by ID.
MqttProperties.MqttProperty	getProperty(int propertyId)	Get property by ID.
boolean	isEmpty()
java.util.Collection<? extends MqttProperties.MqttProperty>	listAll()
(package private) static MqttProperties	withEmptyDefaults(MqttProperties properties)

Methods inherited from class java.lang.Object

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

Field Detail

PAYLOAD_FORMAT_INDICATOR

public static final int PAYLOAD_FORMAT_INDICATOR

See Also:

Constant Field Values

REQUEST_PROBLEM_INFORMATION

public static final int REQUEST_PROBLEM_INFORMATION

See Also:

Constant Field Values

REQUEST_RESPONSE_INFORMATION

public static final int REQUEST_RESPONSE_INFORMATION

See Also:

Constant Field Values

MAXIMUM_QOS

public static final int MAXIMUM_QOS

See Also:

Constant Field Values

RETAIN_AVAILABLE

public static final int RETAIN_AVAILABLE

See Also:

Constant Field Values

WILDCARD_SUBSCRIPTION_AVAILABLE

public static final int WILDCARD_SUBSCRIPTION_AVAILABLE

See Also:

Constant Field Values

SUBSCRIPTION_IDENTIFIER_AVAILABLE

public static final int SUBSCRIPTION_IDENTIFIER_AVAILABLE

See Also:

Constant Field Values

SHARED_SUBSCRIPTION_AVAILABLE

public static final int SHARED_SUBSCRIPTION_AVAILABLE

See Also:

Constant Field Values

SERVER_KEEP_ALIVE

public static final int SERVER_KEEP_ALIVE

See Also:

Constant Field Values

RECEIVE_MAXIMUM

public static final int RECEIVE_MAXIMUM

See Also:

Constant Field Values

TOPIC_ALIAS_MAXIMUM

public static final int TOPIC_ALIAS_MAXIMUM

See Also:

Constant Field Values

TOPIC_ALIAS

public static final int TOPIC_ALIAS

See Also:

Constant Field Values

PUBLICATION_EXPIRY_INTERVAL

public static final int PUBLICATION_EXPIRY_INTERVAL

See Also:

Constant Field Values

SESSION_EXPIRY_INTERVAL

public static final int SESSION_EXPIRY_INTERVAL

See Also:

Constant Field Values

WILL_DELAY_INTERVAL

public static final int WILL_DELAY_INTERVAL

See Also:

Constant Field Values

MAXIMUM_PACKET_SIZE

public static final int MAXIMUM_PACKET_SIZE

See Also:

Constant Field Values

SUBSCRIPTION_IDENTIFIER

public static final int SUBSCRIPTION_IDENTIFIER

See Also:

Constant Field Values

CONTENT_TYPE

public static final int CONTENT_TYPE

See Also:

Constant Field Values

RESPONSE_TOPIC

public static final int RESPONSE_TOPIC

See Also:

Constant Field Values

ASSIGNED_CLIENT_IDENTIFIER

public static final int ASSIGNED_CLIENT_IDENTIFIER

See Also:

Constant Field Values

AUTHENTICATION_METHOD

public static final int AUTHENTICATION_METHOD

See Also:

Constant Field Values

RESPONSE_INFORMATION

public static final int RESPONSE_INFORMATION

See Also:

Constant Field Values

SERVER_REFERENCE

public static final int SERVER_REFERENCE

See Also:

Constant Field Values

REASON_STRING

public static final int REASON_STRING

See Also:

Constant Field Values

USER_PROPERTY

public static final int USER_PROPERTY

See Also:

Constant Field Values

CORRELATION_DATA

public static final int CORRELATION_DATA

See Also:

Constant Field Values

AUTHENTICATION_DATA

public static final int AUTHENTICATION_DATA

See Also:

Constant Field Values

NO_PROPERTIES

public static final MqttProperties NO_PROPERTIES

props

private IntObjectHashMap<MqttProperties.MqttProperty> props

userProperties

private java.util.List<MqttProperties.UserProperty> userProperties

subscriptionIds

private java.util.List<MqttProperties.IntegerProperty> subscriptionIds

canModify

private final boolean canModify

Constructor Detail

MqttProperties

public MqttProperties()

MqttProperties

private MqttProperties(boolean canModify)

Method Detail

withEmptyDefaults

static MqttProperties withEmptyDefaults(MqttProperties properties)

add

public void add(MqttProperties.MqttProperty property)

listAll

public java.util.Collection<? extends MqttProperties.MqttProperty> listAll()

isEmpty

public boolean isEmpty()

getProperty

public MqttProperties.MqttProperty getProperty(int propertyId)

Get property by ID. If there are multiple properties of this type (can be with Subscription ID) then return the first one.

Parameters:

propertyId - ID of the property

Returns:

a property if it is set, null otherwise

getProperties

public java.util.List<? extends MqttProperties.MqttProperty> getProperties(int propertyId)

Get properties by ID. Some properties (Subscription ID and User Properties) may occur multiple times, this method returns all their values in order.

Parameters:

propertyId - ID of the property

Returns:

all properties having specified ID