Package com.hivemq.extension.sdk.api.packets.auth

Enum AuthReasonCode

java.lang.Object

java.lang.Enum<AuthReasonCode>

com.hivemq.extension.sdk.api.packets.auth.AuthReasonCode

All Implemented Interfaces:

Serializable, Comparable<AuthReasonCode>

public enum AuthReasonCode
extends Enum<AuthReasonCode>

Since:

4.3.0, CE 2020.1

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONTINUE_AUTHENTICATION	CONTINUE_AUTHENTICATION reason code is sent when client authentication needs further authentication.
REAUTHENTICATE	REAUTHENTICATE reason code is sent when re-authentication is needed.
SUCCESS	SUCCESS reason code is sent when client authentication completed successfully.

Method Summary

Modifier and Type	Method	Description
static AuthReasonCode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AuthReasonCode[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SUCCESS

public static final AuthReasonCode SUCCESS

SUCCESS reason code is sent when client authentication completed successfully.

Since:

4.3.0, CE 2020.1

CONTINUE_AUTHENTICATION

public static final AuthReasonCode CONTINUE_AUTHENTICATION

CONTINUE_AUTHENTICATION reason code is sent when client authentication needs further authentication.

Since:

4.3.0, CE 2020.1

REAUTHENTICATE

public static final AuthReasonCode REAUTHENTICATE

REAUTHENTICATE reason code is sent when re-authentication is needed.

Since:

4.3.0, CE 2020.1

Method Detail

values

public static AuthReasonCode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AuthReasonCode c : AuthReasonCode.values())
    System.out.println(c);

Returns:

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

valueOf

public static AuthReasonCode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null