Source for javax.security.sasl.SaslException

   1: /* SaslException.java
   2:    Copyright (C) 2003, 2005, 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., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 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: import java.io.IOException;
  42: import java.io.PrintStream;
  43: import java.io.PrintWriter;
  44: import java.io.Serializable;
  45: 
  46: /**
  47:  * This class represents an error that has occurred when using SASL.
  48:  *
  49:  * @since 1.5
  50:  */
  51: public class SaslException extends IOException implements Serializable
  52: {
  53: 
  54:   // Constants and variables
  55:   // -------------------------------------------------------------------------
  56: 
  57:   private static final long serialVersionUID = 4579784287983423626L;
  58: 
  59:   /**
  60:    * @serial The possibly null root cause exception.
  61:    */
  62:   private Throwable _exception = null;
  63: 
  64:   // Constructor(s)
  65:   // -------------------------------------------------------------------------
  66: 
  67:   /**
  68:    * Constructs a new instance of <code>SaslException</code>. The root
  69:    * exception and the detailed message are null.
  70:    */
  71:   public SaslException()
  72:   {
  73:     super();
  74:   }
  75: 
  76:   /**
  77:    * Constructs a new instance of <code>SaslException</code> with a detailed
  78:    * message. The <code>root</code> exception is <code>null</code>.
  79:    *
  80:    * @param detail a possibly null string containing details of the exception.
  81:    * @see Throwable#getMessage()
  82:    */
  83:   public SaslException(String detail)
  84:   {
  85:     super(detail);
  86:   }
  87: 
  88:   /**
  89:    * Constructs a new instance of <code>SaslException</code> with a detailed
  90:    * message and a root exception. For example, a <code>SaslException</code>
  91:    * might result from a problem with the callback handler, which might throw a
  92:    * {@link javax.security.auth.callback.UnsupportedCallbackException} if it
  93:    * does not support the requested callback, or throw an {@link IOException}
  94:    * if it had problems obtaining data for the callback. The
  95:    * <code>SaslException</code>'s root exception would be then be the exception
  96:    * thrown by the callback handler.
  97:    *
  98:    * @param detail a possibly <code>null</code> string containing details of
  99:    * the exception.
 100:    * @param ex a possibly <code>null</code> root exception that caused this
 101:    * exception.
 102:    * @see Throwable#getMessage()
 103:    * @see #getCause()
 104:    */
 105:   public SaslException(String detail, Throwable ex)
 106:   {
 107:     super(detail);
 108:     _exception = ex;
 109:   }
 110: 
 111:   // Class methods
 112:   // -------------------------------------------------------------------------
 113: 
 114:   // Instance methods
 115:   // -------------------------------------------------------------------------
 116: 
 117:   /**
 118:    * Returns the cause of this throwable or <code>null</code> if the cause is
 119:    * nonexistent or unknown. The cause is the throwable that caused this
 120:    * exception to be thrown.
 121:    *
 122:    * @return the possibly <code>null</code> exception that caused this exception.
 123:    */
 124:   public Throwable getCause()
 125:   {
 126:     return _exception;
 127:   }
 128: 
 129:   /**
 130:    * Prints this exception's stack trace to <code>System.err</code>. If this
 131:    * exception has a root exception; the stack trace of the root exception is
 132:    * also printed to <code>System.err</code>.
 133:    */
 134:   public void printStackTrace()
 135:   {
 136:     super.printStackTrace();
 137:     if (_exception != null)
 138:       _exception.printStackTrace();
 139:   }
 140: 
 141:   /**
 142:    * Prints this exception's stack trace to a print stream. If this exception
 143:    * has a root exception; the stack trace of the root exception is also
 144:    * printed to the print stream.
 145:    *
 146:    * @param ps the non-null print stream to which to print.
 147:    */
 148:   public void printStackTrace(PrintStream ps)
 149:   {
 150:     super.printStackTrace(ps);
 151:     if (_exception != null)
 152:       _exception.printStackTrace(ps);
 153:   }
 154: 
 155:   /**
 156:    * Prints this exception's stack trace to a print writer. If this exception
 157:    * has a root exception; the stack trace of the root exception is also
 158:    * printed to the print writer.
 159:    *
 160:    * @param pw the non-null print writer to use for output.
 161:    */
 162:   public void printStackTrace(PrintWriter pw)
 163:   {
 164:     super.printStackTrace(pw);
 165:     if (_exception != null)
 166:       _exception.printStackTrace(pw);
 167:   }
 168: 
 169:   /**
 170:    * Returns the string representation of this exception. The string
 171:    * representation contains this exception's class name, its detailed
 172:    * messsage, and if it has a root exception, the string representation of the
 173:    * root exception. This string representation is meant for debugging and not
 174:    * meant to be interpreted programmatically.
 175:    *
 176:    * @return the non-null string representation of this exception.
 177:    * @see Throwable#getMessage()
 178:    */
 179:   public String toString()
 180:   {
 181:     StringBuffer sb = new StringBuffer(this.getClass().getName())
 182:       .append(": ").append(super.toString());
 183:     if (_exception != null)
 184:       sb.append("; caused by: ").append(_exception.toString());
 185:     return sb.toString();
 186:   }
 187: }