Class AuthenticationException

javax.naming.AuthenticationException

All Implemented Interfaces:: Serializable

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

remainingName, resolvedName, resolvedObj, rootException

Constructor Summary

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

appendRemainingComponent, appendRemainingName, getCause, getExplanation, getRemainingName, getResolvedName, getResolvedObj, getRootCause, initCause, setRemainingName, setResolvedName, setResolvedObj, setRootCause, toString, toString

Methods declared in class java.lang.Throwable

addSuppressed, fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods declared in class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

AuthenticationException

public AuthenticationException(String 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()

AuthenticationException

public AuthenticationException()

Constructs a new instance of AuthenticationException. All fields are set to null.

© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.naming/javax/naming/AuthenticationException.html