Source for javax.security.auth.callback.UnsupportedCallbackException

   1: /* UnsupportedCallbackException.java -- signals an unsupported callback type.
   2:    Copyright (C) 2003, 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.auth.callback;
  40: 
  41: /**
  42:  * Signals that a {@link CallbackHandler} does not recognize a particular
  43:  * {@link Callback}.
  44:  *
  45:  */
  46: public class UnsupportedCallbackException extends Exception
  47: {
  48: 
  49:   // Constants and variables
  50:   // -------------------------------------------------------------------------
  51: 
  52:   /** @serial */
  53:   private Callback callback;
  54: 
  55:   // Constructor(s)
  56:   // -------------------------------------------------------------------------
  57: 
  58:   /**
  59:    * Constructs an <code>UnsupportedCallbackException</code> with no detail
  60:    * message.
  61:    *
  62:    * @param callback the unrecognized {@link Callback}.
  63:    */
  64:   public UnsupportedCallbackException(Callback callback)
  65:   {
  66:     super();
  67: 
  68:     this.callback = callback;
  69:   }
  70: 
  71:   /**
  72:    * Constructs an <code>UnsupportedCallbackException</code> with the specified
  73:    * detail message. A detail message is a {@link String} that describes this
  74:    * particular exception.
  75:    *
  76:    * @param callback the unrecognized {@link Callback}.
  77:    * @param msg the detail message.
  78:    */
  79:   public UnsupportedCallbackException(Callback callback, String msg)
  80:   {
  81:     super(msg);
  82: 
  83:     this.callback = callback;
  84:   }
  85: 
  86:   // Class methods
  87:   // -------------------------------------------------------------------------
  88: 
  89:   // Instance methods
  90:   // -------------------------------------------------------------------------
  91: 
  92:   /**
  93:    * Get the unrecognized {@link Callback}.
  94:    *
  95:    * @return the unrecognized {@link Callback}.
  96:    */
  97:   public Callback getCallback()
  98:   {
  99:     return this.callback;
 100:   }
 101: }