com.hivemq.client.internal.mqtt.message.publish

Class MqttPublish

java.lang.Object

com.hivemq.client.internal.mqtt.message.MqttMessageWithUserProperties

com.hivemq.client.internal.mqtt.message.publish.MqttPublish

All Implemented Interfaces:

MqttMessage, MqttMessage.WithUserProperties, Mqtt5Message, Mqtt5Publish

Direct Known Subclasses:

MqttWillPublish

@Immutable
public class MqttPublish
extends MqttMessageWithUserProperties
implements Mqtt5Publish

Nested Class Summary

Nested classes/interfaces inherited from class com.hivemq.client.internal.mqtt.message.MqttMessageWithUserProperties

MqttMessageWithUserProperties.WithReason

Nested classes/interfaces inherited from interface com.hivemq.client.internal.mqtt.message.MqttMessage

MqttMessage.WithId, MqttMessage.WithUserProperties

Field Summary

Fields

Modifier and Type	Field and Description
static long	NO_MESSAGE_EXPIRY

Fields inherited from interface com.hivemq.client.mqtt.mqtt5.message.publish.Mqtt5Publish

DEFAULT_QOS

Constructor Summary

Constructors

Constructor and Description
MqttPublish(@NotNull MqttTopicImpl topic, @Nullable java.nio.ByteBuffer payload, @NotNull MqttQos qos, boolean retain, long messageExpiryInterval, @Nullable Mqtt5PayloadFormatIndicator payloadFormatIndicator, @Nullable MqttUtf8StringImpl contentType, @Nullable MqttTopicImpl responseTopic, @Nullable java.nio.ByteBuffer correlationData, @NotNull MqttUserPropertiesImpl userProperties)

Method Summary

Modifier and Type	Method and Description
@NotNull MqttWillPublish	asWill() Transforms this Publish message into a Will Publish with the same properties.
@NotNull MqttStatefulPublish	createStateful(int packetIdentifier, boolean dup, int topicAlias, @NotNull ImmutableIntList subscriptionIdentifiers)
@NotNull MqttStatefulPublish	createStateful(int packetIdentifier, boolean dup, @Nullable MqttTopicAliasMapping topicAliasMapping)
MqttPublishBuilder.Default	extend() Creates a builder for extending this Publish message.
@NotNull java.util.Optional<MqttUtf8String>	getContentType()
@NotNull java.util.Optional<java.nio.ByteBuffer>	getCorrelationData()
@NotNull java.util.OptionalLong	getMessageExpiryInterval()
@NotNull java.util.Optional<java.nio.ByteBuffer>	getPayload()
@NotNull byte[]	getPayloadAsBytes()
@NotNull java.util.Optional<Mqtt5PayloadFormatIndicator>	getPayloadFormatIndicator()
@NotNull MqttQos	getQos()
@Nullable MqttUtf8StringImpl	getRawContentType()
@Nullable java.nio.ByteBuffer	getRawCorrelationData()
long	getRawMessageExpiryInterval()
@Nullable java.nio.ByteBuffer	getRawPayload()
@Nullable Mqtt5PayloadFormatIndicator	getRawPayloadFormatIndicator()
@Nullable MqttTopicImpl	getRawResponseTopic()
@NotNull java.util.Optional<MqttTopic>	getResponseTopic()
@NotNull MqttTopicImpl	getTopic()
boolean	isRetain()
protected @NotNull java.lang.String	toAttributeString()
@NotNull java.lang.String	toString()

Methods inherited from class com.hivemq.client.internal.mqtt.message.MqttMessageWithUserProperties

getUserProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hivemq.client.mqtt.mqtt5.message.publish.Mqtt5Publish

builder, getType, getUserProperties

Field Detail

NO_MESSAGE_EXPIRY

public static final long NO_MESSAGE_EXPIRY

See Also:

Constant Field Values

Constructor Detail

MqttPublish

public MqttPublish(@NotNull
                   @NotNull MqttTopicImpl topic,
                   @Nullable
                   @Nullable java.nio.ByteBuffer payload,
                   @NotNull
                   @NotNull MqttQos qos,
                   boolean retain,
                   long messageExpiryInterval,
                   @Nullable
                   @Nullable Mqtt5PayloadFormatIndicator payloadFormatIndicator,
                   @Nullable
                   @Nullable MqttUtf8StringImpl contentType,
                   @Nullable
                   @Nullable MqttTopicImpl responseTopic,
                   @Nullable
                   @Nullable java.nio.ByteBuffer correlationData,
                   @NotNull
                   @NotNull MqttUserPropertiesImpl userProperties)

Method Detail

getTopic

@NotNull
public @NotNull MqttTopicImpl getTopic()

Specified by:

getTopic in interface Mqtt5Publish

Returns:

the topic of this Publish message.

getPayload

@NotNull
public @NotNull java.util.Optional<java.nio.ByteBuffer> getPayload()

Specified by:

getPayload in interface Mqtt5Publish

Returns:

the optional payload of this Publish message.

getRawPayload

@Nullable
public @Nullable java.nio.ByteBuffer getRawPayload()

getPayloadAsBytes

@NotNull
public @NotNull byte[] getPayloadAsBytes()

Specified by:

getPayloadAsBytes in interface Mqtt5Publish

Returns:

the payload of this Publish message as a byte array. Empty byte array if the payload is not present.

getQos

@NotNull
public @NotNull MqttQos getQos()

Specified by:

getQos in interface Mqtt5Publish

Returns:

the QoS of this Publish message.

isRetain

public boolean isRetain()

Specified by:

isRetain in interface Mqtt5Publish

Returns:

whether this Publish message is a retained message.

getMessageExpiryInterval

@NotNull
public @NotNull java.util.OptionalLong getMessageExpiryInterval()

Specified by:

getMessageExpiryInterval in interface Mqtt5Publish

Returns:

the optional message expiry interval in seconds of this Publish message.

getRawMessageExpiryInterval

public long getRawMessageExpiryInterval()

getPayloadFormatIndicator

@NotNull
public @NotNull java.util.Optional<Mqtt5PayloadFormatIndicator> getPayloadFormatIndicator()

Specified by:

getPayloadFormatIndicator in interface Mqtt5Publish

Returns:

the optional payload format indicator of this Publish message.

getRawPayloadFormatIndicator

@Nullable
public @Nullable Mqtt5PayloadFormatIndicator getRawPayloadFormatIndicator()

getContentType

@NotNull
public @NotNull java.util.Optional<MqttUtf8String> getContentType()

Specified by:

getContentType in interface Mqtt5Publish

Returns:

the optional content type of this Publish message.

getRawContentType

@Nullable
public @Nullable MqttUtf8StringImpl getRawContentType()

getResponseTopic

@NotNull
public @NotNull java.util.Optional<MqttTopic> getResponseTopic()

Specified by:

getResponseTopic in interface Mqtt5Publish

Returns:

the optional response topic of this Publish message.

getRawResponseTopic

@Nullable
public @Nullable MqttTopicImpl getRawResponseTopic()

getCorrelationData

@NotNull
public @NotNull java.util.Optional<java.nio.ByteBuffer> getCorrelationData()

Specified by:

getCorrelationData in interface Mqtt5Publish

Returns:

the optional correlation data of this Publish message.

getRawCorrelationData

@Nullable
public @Nullable java.nio.ByteBuffer getRawCorrelationData()

asWill

@NotNull
public @NotNull MqttWillPublish asWill()

Description copied from interface: Mqtt5Publish

Transforms this Publish message into a Will Publish with the same properties.

Specified by:

asWill in interface Mqtt5Publish

Returns:

the Will Publish.

extend

@NotNull
public MqttPublishBuilder.Default extend()

Description copied from interface: Mqtt5Publish

Creates a builder for extending this Publish message.

Specified by:

extend in interface Mqtt5Publish

Returns:

the created builder.

createStateful

@NotNull
public @NotNull MqttStatefulPublish createStateful(int packetIdentifier,
                                                            boolean dup,
                                                            int topicAlias,
                                                            @NotNull
                                                            @NotNull ImmutableIntList subscriptionIdentifiers)

createStateful

@NotNull
public @NotNull MqttStatefulPublish createStateful(int packetIdentifier,
                                                            boolean dup,
                                                            @Nullable
                                                            @Nullable MqttTopicAliasMapping topicAliasMapping)

toAttributeString

@NotNull
protected @NotNull java.lang.String toAttributeString()

Overrides:

toAttributeString in class MqttMessageWithUserProperties

toString

@NotNull
public @NotNull java.lang.String toString()

Overrides:

toString in class java.lang.Object