/*
 * Copyright (c) 1999, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package javax.naming;

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 is invalid or otherwise fails 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 appropriate credentials.

Synchronization and serialization issues that apply to NamingException apply directly here.

Author:Rosanna Lee, Scott Seligman
Since:1.3
/** * 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 is invalid or otherwise fails to * authenticate the user to the naming/directory service. *<p> * 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 * appropriate credentials. * <p> * Synchronization and serialization issues that apply to NamingException * apply directly here. * * @author Rosanna Lee * @author Scott Seligman * @since 1.3 */
public class AuthenticationException extends NamingSecurityException {
Constructs a new instance of AuthenticationException using the explanation supplied. All other fields default to null.
Params:
  • explanation – A possibly null string containing additional detail about this exception.
See Also:
/** * Constructs a new instance of AuthenticationException using the * explanation supplied. All other fields default to null. * * @param explanation A possibly null string containing * additional detail about this exception. * @see java.lang.Throwable#getMessage */
public AuthenticationException(String explanation) { super(explanation); }
Constructs a new instance of AuthenticationException. All fields are set to null.
/** * Constructs a new instance of AuthenticationException. * All fields are set to null. */
public AuthenticationException() { super(); }
Use serialVersionUID from JNDI 1.1.1 for interoperability
/** * Use serialVersionUID from JNDI 1.1.1 for interoperability */
private static final long serialVersionUID = 3678497619904568096L; }