com.hivemq.client.internal.mqtt.message.connect.connack

Class MqttConnAck

java.lang.Object

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

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

com.hivemq.client.internal.mqtt.message.MqttMessageWithUserProperties.WithReason.WithCode<Mqtt5ConnAckReasonCode>

com.hivemq.client.internal.mqtt.message.connect.connack.MqttConnAck

All Implemented Interfaces:

MqttMessage, MqttMessage.WithUserProperties, Mqtt5ConnAck, Mqtt5Message

@Immutable
public class MqttConnAck
extends MqttMessageWithUserProperties.WithReason.WithCode<Mqtt5ConnAckReasonCode>
implements Mqtt5ConnAck

Nested Class Summary

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

MqttMessageWithUserProperties.WithReason.WithCode.WithId<R extends Mqtt5ReasonCode>

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

MqttMessageWithUserProperties.WithReason.WithCode<R extends Mqtt5ReasonCode>, MqttMessageWithUserProperties.WithReason.WithCodesAndId<R extends Mqtt5ReasonCode>

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.WithUserProperties

Field Summary

Fields

Modifier and Type	Field and Description
static int	KEEP_ALIVE_FROM_CONNECT
static long	SESSION_EXPIRY_INTERVAL_FROM_CONNECT

Constructor Summary

Constructors

Constructor and Description

MqttConnAck(@NotNull Mqtt5ConnAckReasonCode reasonCode, boolean sessionPresent, long sessionExpiryInterval, int serverKeepAlive, @Nullable MqttClientIdentifierImpl assignedClientIdentifier, @Nullable Mqtt5EnhancedAuth enhancedAuth, @NotNull MqttConnAckRestrictions restrictions, @Nullable MqttUtf8StringImpl responseInformation, @Nullable MqttUtf8StringImpl serverReference, @Nullable MqttUtf8StringImpl reasonString, @NotNull MqttUserPropertiesImpl userProperties)

Method Summary

Modifier and Type	Method and Description
boolean	equals(@Nullable java.lang.Object o)
@NotNull java.util.Optional<MqttClientIdentifier>	getAssignedClientIdentifier()
@NotNull java.util.Optional<Mqtt5EnhancedAuth>	getEnhancedAuth()
@Nullable MqttClientIdentifierImpl	getRawAssignedClientIdentifier()
@Nullable Mqtt5EnhancedAuth	getRawEnhancedAuth()
int	getRawServerKeepAlive()
long	getRawSessionExpiryInterval()
@NotNull java.util.Optional<MqttUtf8String>	getResponseInformation()
@NotNull MqttConnAckRestrictions	getRestrictions()
@NotNull java.util.OptionalInt	getServerKeepAlive()
@NotNull java.util.Optional<MqttUtf8String>	getServerReference()
@NotNull java.util.OptionalLong	getSessionExpiryInterval()
int	hashCode()
boolean	isSessionPresent()
protected @NotNull java.lang.String	toAttributeString()
@NotNull java.lang.String	toString()

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

getReasonCode, partialEquals, partialHashCode

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

getRawReasonString, getReasonString, partialEquals

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

getUserProperties, partialEquals

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.hivemq.client.mqtt.mqtt5.message.connect.connack.Mqtt5ConnAck

getReasonCode, getReasonString, getType, getUserProperties

Field Detail

SESSION_EXPIRY_INTERVAL_FROM_CONNECT

public static final long SESSION_EXPIRY_INTERVAL_FROM_CONNECT

See Also:

Constant Field Values

KEEP_ALIVE_FROM_CONNECT

public static final int KEEP_ALIVE_FROM_CONNECT

See Also:

Constant Field Values

Constructor Detail

MqttConnAck

public MqttConnAck(@NotNull
                   @NotNull Mqtt5ConnAckReasonCode reasonCode,
                   boolean sessionPresent,
                   long sessionExpiryInterval,
                   int serverKeepAlive,
                   @Nullable
                   @Nullable MqttClientIdentifierImpl assignedClientIdentifier,
                   @Nullable
                   @Nullable Mqtt5EnhancedAuth enhancedAuth,
                   @NotNull
                   @NotNull MqttConnAckRestrictions restrictions,
                   @Nullable
                   @Nullable MqttUtf8StringImpl responseInformation,
                   @Nullable
                   @Nullable MqttUtf8StringImpl serverReference,
                   @Nullable
                   @Nullable MqttUtf8StringImpl reasonString,
                   @NotNull
                   @NotNull MqttUserPropertiesImpl userProperties)

Method Detail

isSessionPresent

public boolean isSessionPresent()

Specified by:

isSessionPresent in interface Mqtt5ConnAck

Returns:

whether the server has a session present.

getSessionExpiryInterval

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

Specified by:

getSessionExpiryInterval in interface Mqtt5ConnAck

Returns:

the optional session expiry interval set from the server. If absent, the session expiry interval from the Connect message is used.

getRawSessionExpiryInterval

public long getRawSessionExpiryInterval()

getServerKeepAlive

@NotNull
public @NotNull java.util.OptionalInt getServerKeepAlive()

Specified by:

getServerKeepAlive in interface Mqtt5ConnAck

Returns:

the optional keep alive set from the server. If absent, the keep alive from the Connect message is used.

getRawServerKeepAlive

public int getRawServerKeepAlive()

getAssignedClientIdentifier

@NotNull
public @NotNull java.util.Optional<MqttClientIdentifier> getAssignedClientIdentifier()

Specified by:

getAssignedClientIdentifier in interface Mqtt5ConnAck

Returns:

the optional client identifier assigned by the server. If absent, the client identifier from the Connect message is used.

getRawAssignedClientIdentifier

@Nullable
public @Nullable MqttClientIdentifierImpl getRawAssignedClientIdentifier()

getEnhancedAuth

@NotNull
public @NotNull java.util.Optional<Mqtt5EnhancedAuth> getEnhancedAuth()

Specified by:

getEnhancedAuth in interface Mqtt5ConnAck

Returns:

the optional enhanced authentication and/or authorization related data of this ConnAck message.

getRawEnhancedAuth

@Nullable
public @Nullable Mqtt5EnhancedAuth getRawEnhancedAuth()

getRestrictions

@NotNull
public @NotNull MqttConnAckRestrictions getRestrictions()

Specified by:

getRestrictions in interface Mqtt5ConnAck

Returns:

the restrictions set from the server.

getResponseInformation

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

Specified by:

getResponseInformation in interface Mqtt5ConnAck

Returns:

the optional response information of this ConnAck message to retrieve a response topic from.

getServerReference

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

Specified by:

getServerReference in interface Mqtt5ConnAck

Returns:

the optional server reference.

toAttributeString

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

Overrides:

toAttributeString in class MqttMessageWithUserProperties.WithReason

toString

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

Overrides:

toString in class java.lang.Object

equals

public boolean equals(@Nullable
                      @Nullable java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object