Package org.apache.kafka.common.errors

Class AuthenticationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.apache.kafka.common.KafkaException

org.apache.kafka.common.errors.ApiException

org.apache.kafka.common.errors.AuthenticationException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

IllegalSaslStateException, SaslAuthenticationException, SslAuthenticationException, UnsupportedSaslMechanismException

public class AuthenticationException
extends ApiException

This exception indicates that SASL authentication has failed. On authentication failure, clients abort the operation requested and raise one of the subclasses of this exception:

SaslAuthenticationException if SASL handshake fails with invalid credentials or any other failure specific to the SASL mechanism used for authentication
• UnsupportedSaslMechanismException if the SASL mechanism requested by the client is not supported on the broker.
• IllegalSaslStateException if an unexpected request is received on during SASL handshake. This could be due to misconfigured security protocol.
• SslAuthenticationException if SSL handshake failed due to any SSLException.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AuthenticationException(String message)
AuthenticationException(String message, Throwable cause)
AuthenticationException(String message, Throwable cause, org.apache.kafka.server.audit.AuthenticationErrorInfo errorInfo)
AuthenticationException(String message, org.apache.kafka.server.audit.AuthenticationErrorInfo errorInfo)
AuthenticationException(Throwable cause)
AuthenticationException(Throwable cause, org.apache.kafka.server.audit.AuthenticationErrorInfo errorInfo)

Method Summary

Modifier and Type	Method	Description
org.apache.kafka.server.audit.AuthenticationErrorInfo	errorInfo()
String	errorMessage()	This message is for internal logging/auditing and should not be returned to clients.
String	logMessage()	This message is for internal logging and should not be returned to clients.

Methods inherited from class org.apache.kafka.common.errors.ApiException

fillInStackTrace

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

AuthenticationException

public AuthenticationException(String message)

AuthenticationException

public AuthenticationException(Throwable cause)

AuthenticationException

public AuthenticationException(Throwable cause,
 org.apache.kafka.server.audit.AuthenticationErrorInfo errorInfo)

AuthenticationException

public AuthenticationException(String message,
 Throwable cause)

AuthenticationException

public AuthenticationException(String message,
 org.apache.kafka.server.audit.AuthenticationErrorInfo errorInfo)

AuthenticationException

public AuthenticationException(String message,
 Throwable cause,
 org.apache.kafka.server.audit.AuthenticationErrorInfo errorInfo)

Method Details

errorInfo

public org.apache.kafka.server.audit.AuthenticationErrorInfo errorInfo()

logMessage

public String logMessage()

This message is for internal logging and should not be returned to clients.

errorMessage

public String errorMessage()

This message is for internal logging/auditing and should not be returned to clients.