Package com.hivemq.client.mqtt.mqtt5.message.auth

Enum Class Mqtt5AuthReasonCode

java.lang.Object

java.lang.Enum<Mqtt5AuthReasonCode>

com.hivemq.client.mqtt.mqtt5.message.auth.Mqtt5AuthReasonCode

All Implemented Interfaces:

Mqtt5ReasonCode, Serializable, Comparable<Mqtt5AuthReasonCode>, Constable

public enum Mqtt5AuthReasonCode
extends Enum<Mqtt5AuthReasonCode>
implements Mqtt5ReasonCode

Reason Code of an MQTT 5 Auth message.

Since:

1.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONTINUE_AUTHENTICATION	Continue the authentication with another step.
REAUTHENTICATE	Initiate a re-authentication.
SUCCESS	Authentication is successful.

Method Summary

Modifier and Type	Method	Description
boolean	canBeSentByClient()
boolean	canBeSentByServer()
static @Nullable Mqtt5AuthReasonCode	fromCode(int code)	Returns the Auth Reason Code belonging to the given byte code.
int	getCode()
static Mqtt5AuthReasonCode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Mqtt5AuthReasonCode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.hivemq.client.mqtt.mqtt5.message.Mqtt5ReasonCode

canBeSetByUser, isError

Enum Constant Details

SUCCESS

public static final Mqtt5AuthReasonCode SUCCESS

Authentication is successful.

CONTINUE_AUTHENTICATION

public static final Mqtt5AuthReasonCode CONTINUE_AUTHENTICATION

Continue the authentication with another step.

REAUTHENTICATE

public static final Mqtt5AuthReasonCode REAUTHENTICATE

Initiate a re-authentication.

Method Details

values

public static Mqtt5AuthReasonCode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Mqtt5AuthReasonCode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getCode

public int getCode()

Specified by:

getCode in interface Mqtt5ReasonCode

Returns:

the byte code of this Reason Code.

fromCode

@Nullable
public static @Nullable Mqtt5AuthReasonCode fromCode(int code)

Returns the Auth Reason Code belonging to the given byte code.

Parameters:

code - the byte code.

Returns:

the Auth Reason Code belonging to the given byte code or null if the byte code is not a valid Auth Reason Code.

canBeSentByServer

public boolean canBeSentByServer()

Specified by:

canBeSentByServer in interface Mqtt5ReasonCode

Returns:

whether this Reason Code can be sent by the server according to the MQTT 5 specification.

canBeSentByClient

public boolean canBeSentByClient()

Specified by:

canBeSentByClient in interface Mqtt5ReasonCode

Returns:

whether this Reason Code can be sent by the client according to the MQTT 5 specification.