AuthenticationException (Java SE 11 & JDK 11 ) (original) (raw)

• java.lang.Object

• • java.lang.Throwable
  • • java.lang.Exception
      • • javax.naming.NamingException
          * * javax.naming.NamingSecurityException
          * * javax.naming.AuthenticationException

• All Implemented Interfaces:
  [Serializable](../../../java.base/java/io/Serializable.html "interface in java.io")

public class AuthenticationException
extends NamingSecurityException
This exception is thrown when an authentication error occurs while accessing the naming or directory service. An authentication error can happen, for example, when the credentials supplied by the user program are invalid or otherwise fail to authenticate the user to the naming/directory service.
If the program wants to handle this exception in particular, it should catch AuthenticationException explicitly before attempting to catch NamingException. After catching AuthenticationException, the program could reattempt the authentication by updating the resolved context's environment properties with the appropriate credentials.
Synchronization and serialization issues that apply to NamingException apply directly here.
Since:
1.3
See Also:
Serialized Form

• • Field Summary

     * ### Fields declared in class javax.naming.[NamingException](NamingException.html "class in javax.naming")  
     `[remainingName](NamingException.html#remainingName), [resolvedName](NamingException.html#resolvedName), [resolvedObj](NamingException.html#resolvedObj), [rootException](NamingException.html#rootException)`  

  • Constructor Summary

  Constructors

  Constructor	Description
  AuthenticationException()	Constructs a new instance of AuthenticationException.
  AuthenticationException​(String explanation)	Constructs a new instance of AuthenticationException using the explanation supplied.

  • Method Summary

    * ### Methods declared in class javax.naming.[NamingException](NamingException.html "class in javax.naming")  
    `[appendRemainingComponent](NamingException.html#appendRemainingComponent%28java.lang.String%29), [appendRemainingName](NamingException.html#appendRemainingName%28javax.naming.Name%29), [getCause](NamingException.html#getCause%28%29), [getExplanation](NamingException.html#getExplanation%28%29), [getRemainingName](NamingException.html#getRemainingName%28%29), [getResolvedName](NamingException.html#getResolvedName%28%29), [getResolvedObj](NamingException.html#getResolvedObj%28%29), [getRootCause](NamingException.html#getRootCause%28%29), [initCause](NamingException.html#initCause%28java.lang.Throwable%29), [setRemainingName](NamingException.html#setRemainingName%28javax.naming.Name%29), [setResolvedName](NamingException.html#setResolvedName%28javax.naming.Name%29), [setResolvedObj](NamingException.html#setResolvedObj%28java.lang.Object%29), [setRootCause](NamingException.html#setRootCause%28java.lang.Throwable%29), [toString](NamingException.html#toString%28%29), [toString](NamingException.html#toString%28boolean%29)`  
    * ### Methods declared in class java.lang.[Throwable](../../../java.base/java/lang/Throwable.html "class in java.lang")  
    `[addSuppressed](../../../java.base/java/lang/Throwable.html#addSuppressed%28java.lang.Throwable%29), [fillInStackTrace](../../../java.base/java/lang/Throwable.html#fillInStackTrace%28%29), [getLocalizedMessage](../../../java.base/java/lang/Throwable.html#getLocalizedMessage%28%29), [getMessage](../../../java.base/java/lang/Throwable.html#getMessage%28%29), [getStackTrace](../../../java.base/java/lang/Throwable.html#getStackTrace%28%29), [getSuppressed](../../../java.base/java/lang/Throwable.html#getSuppressed%28%29), [printStackTrace](../../../java.base/java/lang/Throwable.html#printStackTrace%28%29), [printStackTrace](../../../java.base/java/lang/Throwable.html#printStackTrace%28java.io.PrintStream%29), [printStackTrace](../../../java.base/java/lang/Throwable.html#printStackTrace%28java.io.PrintWriter%29), [setStackTrace](../../../java.base/java/lang/Throwable.html#setStackTrace%28java.lang.StackTraceElement%5B%5D%29)`  
    * ### Methods declared in class java.lang.[Object](../../../java.base/java/lang/Object.html "class in java.lang")  
    `[clone](../../../java.base/java/lang/Object.html#clone%28%29), [equals](../../../java.base/java/lang/Object.html#equals%28java.lang.Object%29), [finalize](../../../java.base/java/lang/Object.html#finalize%28%29), [getClass](../../../java.base/java/lang/Object.html#getClass%28%29), [hashCode](../../../java.base/java/lang/Object.html#hashCode%28%29), [notify](../../../java.base/java/lang/Object.html#notify%28%29), [notifyAll](../../../java.base/java/lang/Object.html#notifyAll%28%29), [wait](../../../java.base/java/lang/Object.html#wait%28%29), [wait](../../../java.base/java/lang/Object.html#wait%28long%29), [wait](../../../java.base/java/lang/Object.html#wait%28long,int%29)`

• • Constructor Detail

     * #### AuthenticationException  
     public AuthenticationException​([String](../../../java.base/java/lang/String.html "class in java.lang") explanation)  
     Constructs a new instance of AuthenticationException using the explanation supplied. All other fields default to null.  
     Parameters:  
     `explanation` \- A possibly null string containing additional detail about this exception.  
     See Also:  
     [Throwable.getMessage()](../../../java.base/java/lang/Throwable.html#getMessage%28%29)  
     * #### AuthenticationException  
     public AuthenticationException()  
     Constructs a new instance of AuthenticationException. All fields are set to null.

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2025, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.