org.apache.kafka.common.errors

Class SaslAuthenticationException

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

org.apache.kafka.common.errors.SaslAuthenticationException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AuthenticationTimeoutException

public class SaslAuthenticationException
extends AuthenticationException

This exception indicates that SASL authentication has failed. The error message in the exception indicates the actual cause of failure.

SASL authentication failures typically indicate invalid credentials, but could also include other failures specific to the SASL mechanism used for authentication.

Note:If SaslServer.evaluateResponse(byte[]) throws this exception during authentication, the message from the exception will be sent to clients in the SaslAuthenticate response. Custom SaslServer implementations may throw this exception in order to provide custom error messages to clients, but should take care not to include any security-critical information in the message that should not be leaked to unauthenticated clients.

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

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

errorInfo, errorMessage, logMessage

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 Detail

SaslAuthenticationException

public SaslAuthenticationException(String message)

SaslAuthenticationException

public SaslAuthenticationException(String message,
                                   Throwable cause)

SaslAuthenticationException

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

SaslAuthenticationException

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