001/* UnsupportedCallbackException.java -- signals an unsupported callback type.
002   Copyright (C) 2003, 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.auth.callback;
040
041/**
042 * Signals that a {@link CallbackHandler} does not recognize a particular
043 * {@link Callback}.
044 *
045 */
046public class UnsupportedCallbackException extends Exception
047{
048
049  // Constants and variables
050  // -------------------------------------------------------------------------
051
052  /** @serial */
053  private Callback callback;
054
055  // Constructor(s)
056  // -------------------------------------------------------------------------
057
058  /**
059   * Constructs an <code>UnsupportedCallbackException</code> with no detail
060   * message.
061   *
062   * @param callback the unrecognized {@link Callback}.
063   */
064  public UnsupportedCallbackException(Callback callback)
065  {
066    super();
067
068    this.callback = callback;
069  }
070
071  /**
072   * Constructs an <code>UnsupportedCallbackException</code> with the specified
073   * detail message. A detail message is a {@link String} that describes this
074   * particular exception.
075   *
076   * @param callback the unrecognized {@link Callback}.
077   * @param msg the detail message.
078   */
079  public UnsupportedCallbackException(Callback callback, String msg)
080  {
081    super(msg);
082
083    this.callback = callback;
084  }
085
086  // Class methods
087  // -------------------------------------------------------------------------
088
089  // Instance methods
090  // -------------------------------------------------------------------------
091
092  /**
093   * Get the unrecognized {@link Callback}.
094   *
095   * @return the unrecognized {@link Callback}.
096   */
097  public Callback getCallback()
098  {
099    return this.callback;
100  }
101}