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

Class MqttConnect

java.lang.Object

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

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

All Implemented Interfaces:

MqttMessage, MqttMessage.WithUserProperties, Mqtt5Connect, Mqtt5Message

@Immutable
public class MqttConnect
extends MqttMessageWithUserProperties
implements Mqtt5Connect

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 @NotNull MqttConnect	DEFAULT

Fields inherited from interface com.hivemq.client.mqtt.mqtt5.message.connect.Mqtt5Connect

DEFAULT_CLEAN_START, DEFAULT_KEEP_ALIVE, DEFAULT_SESSION_EXPIRY_INTERVAL, NO_KEEP_ALIVE, NO_SESSION_EXPIRY

Constructor Summary

Constructors

Constructor and Description
MqttConnect(int keepAlive, boolean cleanStart, long sessionExpiryInterval, @NotNull MqttConnectRestrictions restrictions, @Nullable MqttSimpleAuth simpleAuth, @Nullable Mqtt5EnhancedAuthMechanism enhancedAuthMechanism, @Nullable MqttWillPublish willPublish, @NotNull MqttUserPropertiesImpl userProperties)

Method Summary

Modifier and Type	Method and Description
@NotNull MqttStatefulConnect	createStateful(@NotNull MqttClientIdentifierImpl clientIdentifier, @Nullable MqttEnhancedAuth enhancedAuth)
boolean	equals(@Nullable java.lang.Object o)
MqttConnectBuilder.Default	extend() Creates a builder for extending this Connect message.
@NotNull java.util.Optional<Mqtt5EnhancedAuthMechanism>	getEnhancedAuthMechanism()
int	getKeepAlive()
@Nullable Mqtt5EnhancedAuthMechanism	getRawEnhancedAuthMechanism()
@Nullable MqttSimpleAuth	getRawSimpleAuth()
@Nullable MqttWillPublish	getRawWillPublish()
@NotNull MqttConnectRestrictions	getRestrictions()
long	getSessionExpiryInterval()
@NotNull java.util.Optional<Mqtt5SimpleAuth>	getSimpleAuth()
@NotNull java.util.Optional<Mqtt5WillPublish>	getWillPublish()
int	hashCode()
boolean	isCleanStart()
@NotNull MqttConnect	setDefaults(@NotNull MqttClientConfig clientConfig)
protected @NotNull java.lang.String	toAttributeString()
@NotNull java.lang.String	toString()

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

getUserProperties, partialEquals, partialHashCode

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

builder, getType, getUserProperties

Field Detail

DEFAULT

@NotNull
public static final @NotNull MqttConnect DEFAULT

Constructor Detail

MqttConnect

public MqttConnect(int keepAlive,
                   boolean cleanStart,
                   long sessionExpiryInterval,
                   @NotNull
                   @NotNull MqttConnectRestrictions restrictions,
                   @Nullable
                   @Nullable MqttSimpleAuth simpleAuth,
                   @Nullable
                   @Nullable Mqtt5EnhancedAuthMechanism enhancedAuthMechanism,
                   @Nullable
                   @Nullable MqttWillPublish willPublish,
                   @NotNull
                   @NotNull MqttUserPropertiesImpl userProperties)

Method Detail

getKeepAlive

public int getKeepAlive()

Specified by:

getKeepAlive in interface Mqtt5Connect

Returns:

the keep alive in seconds the client wants to use.

isCleanStart

public boolean isCleanStart()

Specified by:

isCleanStart in interface Mqtt5Connect

Returns:

whether the client has no session present or wants to clear a present session.

getSessionExpiryInterval

public long getSessionExpiryInterval()

Specified by:

getSessionExpiryInterval in interface Mqtt5Connect

Returns:

the session expiry interval in seconds the client wants to use. The default is Mqtt5Connect.DEFAULT_SESSION_EXPIRY_INTERVAL. If it is Mqtt5Connect.NO_SESSION_EXPIRY the session does not expire.

getRestrictions

@NotNull
public @NotNull MqttConnectRestrictions getRestrictions()

Specified by:

getRestrictions in interface Mqtt5Connect

Returns:

the restrictions set from the client.

getSimpleAuth

@NotNull
public @NotNull java.util.Optional<Mqtt5SimpleAuth> getSimpleAuth()

Specified by:

getSimpleAuth in interface Mqtt5Connect

Returns:

the optional simple authentication and/or authorization related data of this Connect message.

getRawSimpleAuth

@Nullable
public @Nullable MqttSimpleAuth getRawSimpleAuth()

getEnhancedAuthMechanism

@NotNull
public @NotNull java.util.Optional<Mqtt5EnhancedAuthMechanism> getEnhancedAuthMechanism()

Specified by:

getEnhancedAuthMechanism in interface Mqtt5Connect

Returns:

the optional enhanced authentication and/or authorization mechanism of this Connect message.

getRawEnhancedAuthMechanism

@Nullable
public @Nullable Mqtt5EnhancedAuthMechanism getRawEnhancedAuthMechanism()

getWillPublish

@NotNull
public @NotNull java.util.Optional<Mqtt5WillPublish> getWillPublish()

Specified by:

getWillPublish in interface Mqtt5Connect

Returns:

the optional Will Publish of this Connect message.

getRawWillPublish

@Nullable
public @Nullable MqttWillPublish getRawWillPublish()

extend

@NotNull
public MqttConnectBuilder.Default extend()

Description copied from interface: Mqtt5Connect

Creates a builder for extending this Connect message.

Specified by:

extend in interface Mqtt5Connect

Returns:

the created builder.

setDefaults

@NotNull
public @NotNull MqttConnect setDefaults(@NotNull
                                                 @NotNull MqttClientConfig clientConfig)

createStateful

@NotNull
public @NotNull MqttStatefulConnect createStateful(@NotNull
                                                            @NotNull MqttClientIdentifierImpl clientIdentifier,
                                                            @Nullable
                                                            @Nullable MqttEnhancedAuth enhancedAuth)

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

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