APIdia Launch Partner
Top Description Fields Constructors Methods
javax.security.sasl

public Class AuthenticationException

extends SaslException
Class Inheritance
Imports
java.io.Serial
This exception is thrown by a SASL mechanism implementation to indicate that the SASL exchange has failed due to reasons related to authentication, such as an invalid identity, passphrase, or key.

Note that the lack of an AuthenticationException does not mean that the failure was not due to an authentication error. A SASL mechanism implementation might throw the more general SaslException instead of AuthenticationException if it is unable to determine the nature of the failure, or if does not want to disclose the nature of the failure, for example, due to security reasons.

Authors
Rosanna Lee, Rob Weltman
Since
1.5

Field Summary

Modifier and TypeField and Description
private static final long
serialVersionUID

Hides javax.security.sasl.SaslException.serialVersionUID.

Use serialVersionUID from JSR 28 RI for interoperability

Constructor Summary

AccessConstructor and Description
public
AuthenticationException()

Constructs a new instance of AuthenticationException.

public
AuthenticationException(String
A possibly null string containing details of the exception.
detail)

Constructs a new instance of AuthenticationException with a detailed message.

public
AuthenticationException(String
A possibly null string containing details of the exception.
detail, Throwable
A possibly null root exception that caused this exception.
ex)

Constructs a new instance of AuthenticationException with a detailed message and a root exception.

Method Summary

Inherited from javax.security.sasl.SaslException:
getCauseinitCausetoString

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides javax.security.sasl.SaslException.serialVersionUID.

Use serialVersionUID from JSR 28 RI for interoperability

Annotations
@Serial

Constructor Detail

AuthenticationExceptionback to summary
public AuthenticationException()

Constructs a new instance of AuthenticationException. The root exception and the detailed message are null.

AuthenticationExceptionback to summary
public AuthenticationException(String detail)

Constructs a new instance of AuthenticationException with a detailed message. The root exception is null.

Parameters
detail:String

A possibly null string containing details of the exception.

See Also
java.lang.Throwable#getMessage
AuthenticationExceptionback to summary
public AuthenticationException(String detail, Throwable ex)

Constructs a new instance of AuthenticationException with a detailed message and a root exception.

Parameters
detail:String

A possibly null string containing details of the exception.

ex:Throwable

A possibly null root exception that caused this exception.

See Also
java.lang.Throwable#getMessage, getCause