1 /*
2 * Copyright 2000-2003 Sun Microsystems, Inc. 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. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26 package javax.security.sasl;
27
28 import javax.security.auth.callback.ChoiceCallback;
29
30 /**
31 * This callback is used by <tt>SaslClient</tt> and <tt>SaslServer</tt>
32 * to obtain a realm given a list of realm choices.
33 *
34 * @since 1.5
35 *
36 * @author Rosanna Lee
37 * @author Rob Weltman
38 */
39 public class RealmChoiceCallback extends ChoiceCallback {
40
41 /**
42 * Constructs a <tt>RealmChoiceCallback</tt> with a prompt, a list of
43 * choices and a default choice.
44 *
45 * @param prompt the non-null prompt to use to request the realm.
46 * @param choices the non-null list of realms to choose from.
47 * @param defaultChoice the choice to be used as the default choice
48 * when the list of choices is displayed. It is an index into
49 * the <tt>choices</tt> arary.
50 * @param multiple true if multiple choices allowed; false otherwise
51 * @throws IllegalArgumentException If <tt>prompt</tt> is null or the empty string,
52 * if <tt>choices</tt> has a length of 0, if any element from
53 * <tt>choices</tt> is null or empty, or if <tt>defaultChoice</tt>
54 * does not fall within the array boundary of <tt>choices</tt>
55 */
56 public RealmChoiceCallback(String prompt, String[]choices,
57 int defaultChoice, boolean multiple) {
58 super(prompt, choices, defaultChoice, multiple);
59 }
60
61 private static final long serialVersionUID = -8588141348846281332L;
62 }
Save This Page