1 /*
   2  * Copyright (c) 1999, 2015, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package javax.security.auth.callback;
  27 
  28 /**
  29  * Signals that a {@code CallbackHandler} does not
  30  * recognize a particular {@code Callback}.
  31  *
  32  * @since 1.4
  33  */
  34 public class UnsupportedCallbackException extends Exception {
  35 
  36     private static final long serialVersionUID = -6873556327655666839L;
  37 
  38     /**
  39      * @serial
  40      */
  41     private Callback callback;
  42 
  43     /**
  44      * Constructs an {@code UnsupportedCallbackException}
  45      * with no detail message.
  46      *
  47      * @param callback the unrecognized {@code Callback}.
  48      */
  49     public UnsupportedCallbackException(Callback callback) {
  50         super();
  51         this.callback = callback;
  52     }
  53 
  54     /**
  55      * Constructs a UnsupportedCallbackException with the specified detail
  56      * message.  A detail message is a String that describes this particular
  57      * exception.
  58      *
  59      * @param callback the unrecognized {@code Callback}.
  60      *
  61      * @param msg the detail message.
  62      */
  63     public UnsupportedCallbackException(Callback callback, String msg) {
  64         super(msg);
  65         this.callback = callback;
  66     }
  67 
  68     /**
  69      * Get the unrecognized {@code Callback}.
  70      *
  71      * @return the unrecognized {@code Callback}.
  72      */
  73     public Callback getCallback() {
  74         return callback;
  75     }
  76 }