Class AuthenticationException
- java.lang.Object
-
- java.lang.Throwable
-
- java.lang.Exception
-
- java.io.IOException
-
- javax.security.sasl.SaslException
-
- javax.security.sasl.AuthenticationException
-
- All Implemented Interfaces:
- Serializable
public class AuthenticationException extends SaslException
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.
- Since:
- 1.5
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor and Description AuthenticationException()
Constructs a new instance ofAuthenticationException
.AuthenticationException(String detail)
Constructs a new instance ofAuthenticationException
with a detailed message.AuthenticationException(String detail, Throwable ex)
Constructs a new instance ofAuthenticationException
with a detailed message and a root exception.
-
Method Summary
-
Methods inherited from class javax.security.sasl.SaslException
getCause, initCause, toString
-
Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, printStackTrace, printStackTrace, printStackTrace, setStackTrace
-
-
-
-
Constructor Detail
AuthenticationException
public AuthenticationException()
Constructs a new instance ofAuthenticationException
. The root exception and the detailed message are null.
AuthenticationException
public AuthenticationException(String detail)
Constructs a new instance ofAuthenticationException
with a detailed message. The root exception is null.- Parameters:
-
detail
- A possibly null string containing details of the exception. - See Also:
-
Throwable.getMessage()
AuthenticationException
public AuthenticationException(String detail, Throwable ex)
Constructs a new instance ofAuthenticationException
with a detailed message and a root exception.- Parameters:
-
detail
- A possibly null string containing details of the exception. -
ex
- A possibly null root exception that caused this exception. - See Also:
-
Throwable.getMessage()
,SaslException.getCause()
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.