AuthenticationException (Java Platform SE 8 ) (original) (raw)

• 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	Description
  AuthenticationException()	Constructs a new instance of AuthenticationException.
  AuthenticationException(String detail)	Constructs a new instance of AuthenticationException with a detailed message.
  AuthenticationException(String detail,Throwable ex)	Constructs a new instance of AuthenticationException with a detailed message and a root exception.

  • Method Summary

    * ### Methods inherited from class javax.security.sasl.[SaslException](../../../javax/security/sasl/SaslException.html "class in javax.security.sasl")  
    `[getCause](../../../javax/security/sasl/SaslException.html#getCause--), [initCause](../../../javax/security/sasl/SaslException.html#initCause-java.lang.Throwable-), [toString](../../../javax/security/sasl/SaslException.html#toString--)`  
    * ### Methods inherited from class java.lang.[Throwable](../../../java/lang/Throwable.html "class in java.lang")  
    `[addSuppressed](../../../java/lang/Throwable.html#addSuppressed-java.lang.Throwable-), [fillInStackTrace](../../../java/lang/Throwable.html#fillInStackTrace--), [getLocalizedMessage](../../../java/lang/Throwable.html#getLocalizedMessage--), [getMessage](../../../java/lang/Throwable.html#getMessage--), [getStackTrace](../../../java/lang/Throwable.html#getStackTrace--), [getSuppressed](../../../java/lang/Throwable.html#getSuppressed--), [printStackTrace](../../../java/lang/Throwable.html#printStackTrace--), [printStackTrace](../../../java/lang/Throwable.html#printStackTrace-java.io.PrintStream-), [printStackTrace](../../../java/lang/Throwable.html#printStackTrace-java.io.PrintWriter-), [setStackTrace](../../../java/lang/Throwable.html#setStackTrace-java.lang.StackTraceElement:A-)`  
    * ### Methods inherited from class java.lang.[Object](../../../java/lang/Object.html "class in java.lang")  
    `[clone](../../../java/lang/Object.html#clone--), [equals](../../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../../java/lang/Object.html#finalize--), [getClass](../../../java/lang/Object.html#getClass--), [hashCode](../../../java/lang/Object.html#hashCode--), [notify](../../../java/lang/Object.html#notify--), [notifyAll](../../../java/lang/Object.html#notifyAll--), [wait](../../../java/lang/Object.html#wait--), [wait](../../../java/lang/Object.html#wait-long-), [wait](../../../java/lang/Object.html#wait-long-int-)`

• • Constructor Detail

     * #### AuthenticationException  
     public AuthenticationException()  
     Constructs a new instance of `AuthenticationException`. The root exception and the detailed message are null.  
     * #### AuthenticationException  
     public AuthenticationException([String](../../../java/lang/String.html "class in java.lang") detail)  
     Constructs a new instance of `AuthenticationException` with a detailed message. The root exception is null.  
     Parameters:  
     `detail` \- A possibly null string containing details of the exception.  
     See Also:  
     [Throwable.getMessage()](../../../java/lang/Throwable.html#getMessage--)  
     * #### AuthenticationException  
     public AuthenticationException([String](../../../java/lang/String.html "class in java.lang") detail,  
                                    [Throwable](../../../java/lang/Throwable.html "class in java.lang") ex)  
     Constructs a new instance of `AuthenticationException` 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()](../../../java/lang/Throwable.html#getMessage--), [SaslException.getCause()](../../../javax/security/sasl/SaslException.html#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, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.