001/* AuthenticationException.java --
002   Copyright (C) 2003, 2004, 2005 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package javax.security.sasl;
040
041/**
042 * <p>This exception is thrown by a SASL mechanism implementation to indicate
043 * that the SASL exchange has failed due to reasons related to authentication,
044 * such as an invalid identity, passphrase, or key.</p>
045 *
046 * <p>Note that the lack of an <code>AuthenticationException</code> does not
047 * mean that the failure was not due to an authentication error. A SASL
048 * mechanism implementation might throw the more general {@link SaslException}
049 * instead of <code>AuthenticationException</code> if it is unable to determine
050 * the nature of the failure, or if does not want to disclose the nature of the
051 * failure, for example, due to security reasons.</p>
052 *
053 * @since 1.5
054 */
055public class AuthenticationException extends SaslException
056{
057
058  // Constants and variables
059  // -------------------------------------------------------------------------
060
061  // Constructor(s)
062  // -------------------------------------------------------------------------
063
064  /**
065   * Constructs a new instance of <code>AuthenticationException</code>. The
066   * root exception and the detailed message are <code>null</code>.
067   */
068  public AuthenticationException()
069  {
070    super();
071  }
072
073  /**
074   * Constructs a new instance of <code>AuthenticationException</code> with a
075   * detailed message. The root exception is <code>null</code>.
076   *
077   * @param detail a possibly <code>null</code> string containing details of
078   * the exception.
079   * @see Throwable#getMessage()
080   */
081  public AuthenticationException(String detail)
082  {
083    super(detail);
084  }
085
086  /**
087   * Constructs a new instance of <code>AuthenticationException</code> with a
088   * detailed message and a root exception.
089   *
090   * @param detail a possibly <code>null</code> string containing details of
091   * the exception.
092   * @param ex a possibly <code>null</code> root exception that caused this
093   * exception.
094   * @see Throwable#getMessage()
095   * @see SaslException#getCause()
096   */
097  public AuthenticationException(String detail, Throwable ex)
098  {
099    super(detail, ex);
100  }
101
102  // Class methods
103  // -------------------------------------------------------------------------
104
105  // Instance methods
106  // -------------------------------------------------------------------------
107}