src/java.naming/share/classes/javax/naming/AuthenticationException.java
author herrick
Tue, 24 Sep 2019 13:41:16 -0400
branchJDK-8200758-branch
changeset 58301 e0efb29609bd
parent 47216 71c04702a3d5
permissions -rw-r--r--
8225249 : LinuxDebBundler and LinuxRpmBundler should share more code Submitted-by: asemenyuk Reviewed-by: herrick, almatvee
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     2
 * Copyright (c) 1999, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package javax.naming;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
  * This exception is thrown when an authentication error occurs while
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
  * accessing the naming or directory service.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
  * An authentication error can happen, for example, when the credentials
22974
4bf6c0d73bb8 4682009: Typo in javadocs in javax/naming
igerasim
parents: 5506
diff changeset
    32
  * supplied by the user program are invalid or otherwise fail to
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
  * authenticate the user to the naming/directory service.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
  *<p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
  * If the program wants to handle this exception in particular, it
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
  * should catch AuthenticationException explicitly before attempting to
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
  * catch NamingException. After catching AuthenticationException, the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
  * program could reattempt the authentication by updating
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
  * the resolved context's environment properties with the appropriate
22974
4bf6c0d73bb8 4682009: Typo in javadocs in javax/naming
igerasim
parents: 5506
diff changeset
    40
  * credentials.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
  * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
  * Synchronization and serialization issues that apply to NamingException
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
  * apply directly here.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
  *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
  * @author Rosanna Lee
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
  * @author Scott Seligman
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
  * @since 1.3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
  */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
public class AuthenticationException extends NamingSecurityException {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
     * Constructs a new instance of AuthenticationException using the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
     * explanation supplied. All other fields default to null.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
     * @param   explanation     A possibly null string containing
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
     *                          additional detail about this exception.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
     * @see java.lang.Throwable#getMessage
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
    public AuthenticationException(String explanation) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
        super(explanation);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
      * Constructs a new instance of AuthenticationException.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
      * All fields are set to null.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
      */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
    public AuthenticationException() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
        super();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
     * Use serialVersionUID from JNDI 1.1.1 for interoperability
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
    private static final long serialVersionUID = 3678497619904568096L;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
}