com.hivemq.spi.callback.exception

Class AuthenticationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.hivemq.spi.callback.exception.AuthenticationException

All Implemented Interfaces:

Serializable

public class AuthenticationException
extends Exception

Indicates that the authentication of a certain client failed. As a consequence the client gets disconnected from the broker. The return code, which is sent back to the client, signals what the cause of the failed authentication is. For a complete list of return codes see ReturnCode.

This exception should be used in an implementation of OnAuthenticationCallback

Since:

1.4

Author:

Christian Goetz

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AuthenticationException(ReturnCode returnCode)
AuthenticationException(String message, ReturnCode returnCode)

Method Summary

Methods

Modifier and Type	Method and Description
ReturnCode	getReturnCode()

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationException

public AuthenticationException(ReturnCode returnCode)

AuthenticationException

public AuthenticationException(String message,
                       ReturnCode returnCode)

Method Detail

getReturnCode

public ReturnCode getReturnCode()