libjava/javax/security/sasl/AuthenticationException.java

   1 /* AuthenticationException.java --
   2    Copyright (C) 2003, 2004 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package javax.security.sasl;
  40
  41 /**
  42  * <p>This exception is thrown by a SASL mechanism implementation to indicate
  43  * that the SASL exchange has failed due to reasons related to authentication,
  44  * such as an invalid identity, passphrase, or key.</p>
  45  *
  46  * <p>Note that the lack of an <code>AuthenticationException</code> does not
  47  * mean that the failure was not due to an authentication error. A SASL
  48  * mechanism implementation might throw the more general {@link SaslException}
  49  * instead of <code>AuthenticationException</code> if it is unable to determine
  50  * the nature of the failure, or if does not want to disclose the nature of the
  51  * failure, for example, due to security reasons.</p>
  52  */
  53 public class AuthenticationException extends SaslException
  54 {
  55
  56   // Constants and variables
  57   // -------------------------------------------------------------------------
  58
  59   // Constructor(s)
  60   // -------------------------------------------------------------------------
  61
  62   /**
  63    * Constructs a new instance of <code>AuthenticationException</code>. The
  64    * root exception and the detailed message are <code>null</code>.
  65    */
  66   public AuthenticationException()
  67   {
  68     super();
  69   }
  70
  71   /**
  72    * Constructs a new instance of <code>AuthenticationException</code> with a
  73    * detailed message. The root exception is <code>null</code>.
  74    *
  75    * @param detail a possibly <code>null</code> string containing details of
  76    * the exception.
  77    * @see Throwable#getMessage()
  78    */
  79   public AuthenticationException(String detail)
  80   {
  81     super(detail);
  82   }
  83
  84   /**
  85    * Constructs a new instance of <code>AuthenticationException</code> with a
  86    * detailed message and a root exception.
  87    *
  88    * @param detail a possibly <code>null</code> string containing details of
  89    * the exception.
  90    * @param ex a possibly <code>null</code> root exception that caused this
  91    * exception.
  92    * @see Throwable#getMessage()
  93    * @see SaslException#getCause()
  94    */
  95   public AuthenticationException(String detail, Throwable ex)
  96   {
  97     super(detail, ex);
  98   }
  99
 100   // Class methods
 101   // -------------------------------------------------------------------------
 102
 103   // Instance methods
 104   // -------------------------------------------------------------------------
 105 }