1 /* |
1 /* |
2 * Copyright (c) 2000, 2003, Oracle and/or its affiliates. All rights reserved. |
2 * Copyright (c) 2000, 2013, Oracle and/or its affiliates. All rights reserved. |
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
4 * |
4 * |
5 * This code is free software; you can redistribute it and/or modify it |
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 |
6 * under the terms of the GNU General Public License version 2 only, as |
7 * published by the Free Software Foundation. Oracle designates this |
7 * published by the Free Software Foundation. Oracle designates this |
26 package javax.security.sasl; |
26 package javax.security.sasl; |
27 |
27 |
28 import javax.security.auth.callback.ChoiceCallback; |
28 import javax.security.auth.callback.ChoiceCallback; |
29 |
29 |
30 /** |
30 /** |
31 * This callback is used by <tt>SaslClient</tt> and <tt>SaslServer</tt> |
31 * This callback is used by {@code SaslClient} and {@code SaslServer} |
32 * to obtain a realm given a list of realm choices. |
32 * to obtain a realm given a list of realm choices. |
33 * |
33 * |
34 * @since 1.5 |
34 * @since 1.5 |
35 * |
35 * |
36 * @author Rosanna Lee |
36 * @author Rosanna Lee |
37 * @author Rob Weltman |
37 * @author Rob Weltman |
38 */ |
38 */ |
39 public class RealmChoiceCallback extends ChoiceCallback { |
39 public class RealmChoiceCallback extends ChoiceCallback { |
40 |
40 |
41 /** |
41 /** |
42 * Constructs a <tt>RealmChoiceCallback</tt> with a prompt, a list of |
42 * Constructs a {@code RealmChoiceCallback} with a prompt, a list of |
43 * choices and a default choice. |
43 * choices and a default choice. |
44 * |
44 * |
45 * @param prompt the non-null prompt to use to request the realm. |
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. |
46 * @param choices the non-null list of realms to choose from. |
47 * @param defaultChoice the choice to be used as the default choice |
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 |
48 * when the list of choices is displayed. It is an index into |
49 * the <tt>choices</tt> arary. |
49 * the {@code choices} arary. |
50 * @param multiple true if multiple choices allowed; false otherwise |
50 * @param multiple true if multiple choices allowed; false otherwise |
51 * @throws IllegalArgumentException If <tt>prompt</tt> is null or the empty string, |
51 * @throws IllegalArgumentException If {@code prompt} is null or the empty string, |
52 * if <tt>choices</tt> has a length of 0, if any element from |
52 * if {@code choices} has a length of 0, if any element from |
53 * <tt>choices</tt> is null or empty, or if <tt>defaultChoice</tt> |
53 * {@code choices} is null or empty, or if {@code defaultChoice} |
54 * does not fall within the array boundary of <tt>choices</tt> |
54 * does not fall within the array boundary of {@code choices} |
55 */ |
55 */ |
56 public RealmChoiceCallback(String prompt, String[]choices, |
56 public RealmChoiceCallback(String prompt, String[]choices, |
57 int defaultChoice, boolean multiple) { |
57 int defaultChoice, boolean multiple) { |
58 super(prompt, choices, defaultChoice, multiple); |
58 super(prompt, choices, defaultChoice, multiple); |
59 } |
59 } |