Mqtt5ConnAckReasonCode (hivemq-mqtt-client 1.2.0 API)

java.lang.Object
- java.lang.Enum<Mqtt5ConnAckReasonCode>
- - com.hivemq.client.mqtt.mqtt5.message.connect.connack.Mqtt5ConnAckReasonCode

All Implemented Interfaces:

Mqtt5ReasonCode, java.io.Serializable, java.lang.Comparable<Mqtt5ConnAckReasonCode>
```
public enum Mqtt5ConnAckReasonCode
extends java.lang.Enum<Mqtt5ConnAckReasonCode>
implements Mqtt5ReasonCode
```
Reason Code of an MQTT 5 ConnAck message.

Since:

1.0

Enum Constant Summary

Enum Constants
Enum Constant and Description
`BAD_AUTHENTICATION_METHOD` The authentication method is not supported or does not match the authentication method currently in use.
`BAD_USER_NAME_OR_PASSWORD` The server does not accept the user name or password specified by the client.
`BANNED` This client has been banned by administrative action.
`CLIENT_IDENTIFIER_NOT_VALID` The client identifier is formed correctly but is not accepted by the server.
`CONNECTION_RATE_EXCEEDED` The connection rate limit has been exceeded.
`IMPLEMENTATION_SPECIFIC_ERROR` The CONNECT packet is valid but is not accepted by the server.
`MALFORMED_PACKET` The CONNECT packet could not be parsed correctly according to the MQTT specification.
`NOT_AUTHORIZED` The client is not authorized to connect.
`PACKET_TOO_LARGE` The CONNECT packet exceeded the maximum permissible size.
`PAYLOAD_FORMAT_INVALID` The Will payload does not match the specified payload format indicator.
`PROTOCOL_ERROR` The CONNECT packet contained data that is not allowed by the MQTT protocol.
`QOS_NOT_SUPPORTED` The server does not support the QoS of the Will.
`QUOTA_EXCEEDED` An implementation or administrative imposed limit has been exceeded.
`RETAIN_NOT_SUPPORTED` The server does not support retained messages, but the Will retain flag was set.
`SERVER_BUSY` The server is busy.
`SERVER_MOVED` The client should permanently use another server.
`SERVER_UNAVAILABLE` The MQTT service is not available.
`SUCCESS` The connection is accepted.
`TOPIC_NAME_INVALID` The Will topic name is formed correctly but is not accepted by the server.
`UNSPECIFIED_ERROR` The server either does not want to reveal the reason for the failure or none of the other reason codes apply.
`UNSUPPORTED_PROTOCOL_VERSION` The server does not support the version of the MQTT protocol requested by the client.
`USE_ANOTHER_SERVER` The client should temporarily use another server.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static @Nullable Mqtt5ConnAckReasonCode`	`fromCode(int code)` Returns the CONNACK Reason Code belonging to the given byte code.
`int`	`getCode()`
`static Mqtt5ConnAckReasonCode`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static Mqtt5ConnAckReasonCode[]`	`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

Methods inherited from interface com.hivemq.client.mqtt.mqtt5.message.Mqtt5ReasonCode
canBeSentByClient, canBeSentByServer, canBeSetByUser, isError

- Enum Constant Detail
  - SUCCESS
```
public static final Mqtt5ConnAckReasonCode SUCCESS
```
    The connection is accepted.
  - UNSPECIFIED_ERROR
```
public static final Mqtt5ConnAckReasonCode UNSPECIFIED_ERROR
```
    The server either does not want to reveal the reason for the failure or none of the other reason codes apply.
  - MALFORMED_PACKET
```
public static final Mqtt5ConnAckReasonCode MALFORMED_PACKET
```
    The CONNECT packet could not be parsed correctly according to the MQTT specification.
  - PROTOCOL_ERROR
```
public static final Mqtt5ConnAckReasonCode PROTOCOL_ERROR
```
    The CONNECT packet contained data that is not allowed by the MQTT protocol.
  - IMPLEMENTATION_SPECIFIC_ERROR
```
public static final Mqtt5ConnAckReasonCode IMPLEMENTATION_SPECIFIC_ERROR
```
    The CONNECT packet is valid but is not accepted by the server.
  - UNSUPPORTED_PROTOCOL_VERSION
```
public static final Mqtt5ConnAckReasonCode UNSUPPORTED_PROTOCOL_VERSION
```
    The server does not support the version of the MQTT protocol requested by the client.
  - CLIENT_IDENTIFIER_NOT_VALID
```
public static final Mqtt5ConnAckReasonCode CLIENT_IDENTIFIER_NOT_VALID
```
    The client identifier is formed correctly but is not accepted by the server.
  - BAD_USER_NAME_OR_PASSWORD
```
public static final Mqtt5ConnAckReasonCode BAD_USER_NAME_OR_PASSWORD
```
    The server does not accept the user name or password specified by the client.
  - NOT_AUTHORIZED
```
public static final Mqtt5ConnAckReasonCode NOT_AUTHORIZED
```
    The client is not authorized to connect.
  - SERVER_UNAVAILABLE
```
public static final Mqtt5ConnAckReasonCode SERVER_UNAVAILABLE
```
    The MQTT service is not available.
  - SERVER_BUSY
```
public static final Mqtt5ConnAckReasonCode SERVER_BUSY
```
    The server is busy. Try again later.
  - BANNED
```
public static final Mqtt5ConnAckReasonCode BANNED
```
    This client has been banned by administrative action. Contact the server administrator.
  - BAD_AUTHENTICATION_METHOD
```
public static final Mqtt5ConnAckReasonCode BAD_AUTHENTICATION_METHOD
```
    The authentication method is not supported or does not match the authentication method currently in use.
  - TOPIC_NAME_INVALID
```
public static final Mqtt5ConnAckReasonCode TOPIC_NAME_INVALID
```
    The Will topic name is formed correctly but is not accepted by the server.
  - PACKET_TOO_LARGE
```
public static final Mqtt5ConnAckReasonCode PACKET_TOO_LARGE
```
    The CONNECT packet exceeded the maximum permissible size.
  - QUOTA_EXCEEDED
```
public static final Mqtt5ConnAckReasonCode QUOTA_EXCEEDED
```
    An implementation or administrative imposed limit has been exceeded.
  - PAYLOAD_FORMAT_INVALID
```
public static final Mqtt5ConnAckReasonCode PAYLOAD_FORMAT_INVALID
```
    The Will payload does not match the specified payload format indicator.
  - RETAIN_NOT_SUPPORTED
```
public static final Mqtt5ConnAckReasonCode RETAIN_NOT_SUPPORTED
```
    The server does not support retained messages, but the Will retain flag was set.
  - QOS_NOT_SUPPORTED
```
public static final Mqtt5ConnAckReasonCode QOS_NOT_SUPPORTED
```
    The server does not support the QoS of the Will.
  - USE_ANOTHER_SERVER
```
public static final Mqtt5ConnAckReasonCode USE_ANOTHER_SERVER
```
    The client should temporarily use another server.
  - SERVER_MOVED
```
public static final Mqtt5ConnAckReasonCode SERVER_MOVED
```
    The client should permanently use another server.
  - CONNECTION_RATE_EXCEEDED
```
public static final Mqtt5ConnAckReasonCode CONNECTION_RATE_EXCEEDED
```
    The connection rate limit has been exceeded.
- Method Detail
  - values
```
public static Mqtt5ConnAckReasonCode[] 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 (Mqtt5ConnAckReasonCode c : Mqtt5ConnAckReasonCode.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Mqtt5ConnAckReasonCode valueOf(java.lang.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:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.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 Mqtt5ConnAckReasonCode fromCode(int code)
```
    Returns the CONNACK Reason Code belonging to the given byte code.
    
    Parameters:
    
    code - the byte code.
    
    Returns:
    
    the CONNACK Reason Code belonging to the given byte code or null if the byte code is not a valid CONNACK Reason Code code.

Enum Mqtt5ConnAckReasonCode

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

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

Enum Constant Detail

SUCCESS

UNSPECIFIED_ERROR

MALFORMED_PACKET

PROTOCOL_ERROR

IMPLEMENTATION_SPECIFIC_ERROR

UNSUPPORTED_PROTOCOL_VERSION

CLIENT_IDENTIFIER_NOT_VALID

BAD_USER_NAME_OR_PASSWORD

NOT_AUTHORIZED

SERVER_UNAVAILABLE

SERVER_BUSY

BANNED

BAD_AUTHENTICATION_METHOD

TOPIC_NAME_INVALID

PACKET_TOO_LARGE

QUOTA_EXCEEDED

PAYLOAD_FORMAT_INVALID

RETAIN_NOT_SUPPORTED

QOS_NOT_SUPPORTED

USE_ANOTHER_SERVER

SERVER_MOVED

CONNECTION_RATE_EXCEEDED

Method Detail

values

valueOf

getCode

fromCode