Class MqttProtocolException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.mqtt4j.hato.MqttException

org.mqtt4j.hato.MqttProtocolException

All Implemented Interfaces:

Serializable

public final class MqttProtocolException
extends MqttException

A locally detected failure to process an incoming MQTT packet. The reason distinguishes malformed input, protocol rule violations, receive size limits, and more unacknowledged MQTT 5.0 QoS 1 and QoS 2 publications than the client's Receive Maximum (ReasonCode.RECEIVE_MAXIMUM_EXCEEDED). ReasonCode.PACKET_TOO_LARGE can indicate a local limit rather than a peer protocol violation.

Reported as Disconnection.cause() or as the cause of MqttConnectException or MqttConnectionLostException. Before such a failure closes an established MQTT 5.0 connection, the client sends the broker DISCONNECT with this reason code, which does not stop the broker from publishing the Will. A QoS 2 publication that the broker acknowledges with PUBACK fails with this exception directly, without ending the connection; see MqttPublisher.publish(MqttMessage). A SUBACK that violates the protocol also ends its subscription with this exception; see Subscription.established(). An underlying cause is retained for diagnostics; applications should use this exception and reasonCode() to classify the failure.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
MqttProtocolException(String message, ReasonCode reasonCode)	A failure without an underlying cause.
MqttProtocolException(String message, ReasonCode reasonCode, Throwable cause)	A failure with an underlying cause, which is retained for diagnostics.

Method Summary

Modifier and Type	Method	Description
ReasonCode	reasonCode()	Returns the local failure classification, including for MQTT 3.1.1 connections.

Methods inherited from class Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

MqttProtocolException

public MqttProtocolException(String message,
 ReasonCode reasonCode)

A failure without an underlying cause.

Parameters:

message - the detail message

reasonCode - the local failure classification

Throws:

IllegalArgumentException -

if the reason is not [MALFORMED_PACKET][ReasonCode#MALFORMED_PACKET],
[PROTOCOL_ERROR][ReasonCode#PROTOCOL_ERROR],
[PACKET_TOO_LARGE][ReasonCode#PACKET_TOO_LARGE],
[TOPIC_ALIAS_INVALID][ReasonCode#TOPIC_ALIAS_INVALID], or
[RECEIVE_MAXIMUM_EXCEEDED][ReasonCode#RECEIVE_MAXIMUM_EXCEEDED]

MqttProtocolException

public MqttProtocolException(String message,
 ReasonCode reasonCode,
 Throwable cause)

A failure with an underlying cause, which is retained for diagnostics.

Parameters:

message - the detail message

reasonCode - the local failure classification

cause - the underlying cause

Throws:

IllegalArgumentException -

if the reason is not [MALFORMED_PACKET][ReasonCode#MALFORMED_PACKET],
[PROTOCOL_ERROR][ReasonCode#PROTOCOL_ERROR],
[PACKET_TOO_LARGE][ReasonCode#PACKET_TOO_LARGE],
[TOPIC_ALIAS_INVALID][ReasonCode#TOPIC_ALIAS_INVALID], or
[RECEIVE_MAXIMUM_EXCEEDED][ReasonCode#RECEIVE_MAXIMUM_EXCEEDED]

Method Details

reasonCode

public ReasonCode reasonCode()

Returns the local failure classification, including for MQTT 3.1.1 connections. This is not a reason code received from the broker.

Returns:

the local failure classification, including for MQTT 3.1.1 connections