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

Enum Mqtt3ConnAckReturnCode

java.lang.Object

java.lang.Enum<Mqtt3ConnAckReturnCode>

com.hivemq.client.mqtt.mqtt3.message.connect.connack.Mqtt3ConnAckReturnCode

All Implemented Interfaces:

Mqtt3ReturnCode, Serializable, Comparable<Mqtt3ConnAckReturnCode>

public enum Mqtt3ConnAckReturnCode
extends Enum<Mqtt3ConnAckReturnCode>
implements Mqtt3ReturnCode

Return Code of an MQTT 3 ConnAck message.

Since:

1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
BAD_USER_NAME_OR_PASSWORD The server does not accept the user name or password specified by the client.
IDENTIFIER_REJECTED The client identifier is formed correctly but is not accepted by the server.
NOT_AUTHORIZED The client is not authorized to connect.
SERVER_UNAVAILABLE The MQTT service is not available.
SUCCESS The connection is accepted.
UNSUPPORTED_PROTOCOL_VERSION The server does not support the version of the MQTT protocol requested by the client.

Method Summary

Modifier and Type	Method and Description
static @Nullable Mqtt3ConnAckReturnCode	fromCode(int code) Returns the ConnAck Return Code belonging to the given byte code.
int	getCode()
boolean	isError()
static Mqtt3ConnAckReturnCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static Mqtt3ConnAckReturnCode[]	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 Mqtt3ConnAckReturnCode SUCCESS

The connection is accepted.

UNSUPPORTED_PROTOCOL_VERSION

public static final Mqtt3ConnAckReturnCode UNSUPPORTED_PROTOCOL_VERSION

The server does not support the version of the MQTT protocol requested by the client.

IDENTIFIER_REJECTED

public static final Mqtt3ConnAckReturnCode IDENTIFIER_REJECTED

The client identifier is formed correctly but is not accepted by the server.

SERVER_UNAVAILABLE

public static final Mqtt3ConnAckReturnCode SERVER_UNAVAILABLE

The MQTT service is not available.

BAD_USER_NAME_OR_PASSWORD

public static final Mqtt3ConnAckReturnCode BAD_USER_NAME_OR_PASSWORD

The server does not accept the user name or password specified by the client.

NOT_AUTHORIZED

public static final Mqtt3ConnAckReturnCode NOT_AUTHORIZED

The client is not authorized to connect.

Method Detail

values

public static Mqtt3ConnAckReturnCode[] 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 (Mqtt3ConnAckReturnCode c : Mqtt3ConnAckReturnCode.values())
    System.out.println(c);

Returns:

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

valueOf

public static Mqtt3ConnAckReturnCode 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

getCode

public int getCode()

Specified by:

getCode in interface Mqtt3ReturnCode

Returns:

the byte code of this Return Code.

isError

public boolean isError()

Specified by:

isError in interface Mqtt3ReturnCode

Returns:

whether this Return Code is an Error Code.

fromCode

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

Returns the ConnAck Return Code belonging to the given byte code.

Parameters:

code - the byte code.

Returns:

the ConnAck Return Code belonging to the given byte code or null if the byte code is not a valid ConnAck Return Code.