Source for javax.security.sasl.RealmChoiceCallback

   1: /* RealmChoiceCallback.java --
   2:    Copyright (C) 2003, 2004, 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 javax.security.auth.callback.ChoiceCallback;
  42: 
  43: /**
  44:  * This callback is used by {@link SaslClient} and {@link SaslServer} to obtain
  45:  * a realm given a list of realm choices.
  46:  *
  47:  * @since 1.5
  48:  */
  49: public class RealmChoiceCallback extends ChoiceCallback
  50: {
  51: 
  52:   /**
  53:    * Constructs a <code>RealmChoiceCallback</code> with a prompt, a list of
  54:    * choices and a default choice.
  55:    *
  56:    * @param prompt the non-null prompt to use to request the realm.
  57:    * @param choices the non-null list of realms to choose from.
  58:    * @param defaultChoice the choice to be used as the default when the list of
  59:    * choices is displayed. It is an index into the <code>choices</code> array.
  60:    * @param multiple <code>true</code> if multiple choices allowed;
  61:    * <code>false</code> otherwise.
  62:    * @throws IllegalArgumentException if <code>prompt</code> is <code>null</code>
  63:    * or empty, if <code>choices</code> has a length of <code>0</code>, if any
  64:    * element from <code>choices</code> is <code>null</code> or empty, or if
  65:    * <code>defaultChoice</code> does not fall within the array boundary of
  66:    * <code>choices</code>.
  67:    */
  68:   public RealmChoiceCallback(String prompt, String[] choices, int defaultChoice,
  69:                              boolean multiple)
  70:   {
  71:     super(prompt, choices, defaultChoice, multiple);
  72:   }
  73: }