/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * particular file as subject to the "Classpath" exception as provided

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 */

package javax.security.sasl;

import javax.security.auth.callback.ChoiceCallback;

/**

  * This callback is used by <tt>SaslClient</tt> and <tt>SaslServer</tt>

  * to obtain a realm given a list of realm choices.

  *

  * @since 1.5

  *

  * @author Rosanna Lee

  * @author Rob Weltman

  */

public class RealmChoiceCallback extends ChoiceCallback {

    /**

     * Constructs a <tt>RealmChoiceCallback</tt> with a prompt, a list of

     * choices and a default choice.

     *

     * @param prompt the non-null prompt to use to request the realm.

     * @param choices the non-null list of realms to choose from.

     * @param defaultChoice the choice to be used as the default choice

     * when the list of choices is displayed. It is an index into

     * the <tt>choices</tt> arary.

     * @param multiple true if multiple choices allowed; false otherwise

     * @throws IllegalArgumentException If <tt>prompt</tt> is null or the empty string,

     * if <tt>choices</tt> has a length of 0, if any element from

     * <tt>choices</tt> is null or empty, or if <tt>defaultChoice</tt>

     * does not fall within the array boundary of <tt>choices</tt>

     */

    public RealmChoiceCallback(String prompt, String[]choices,

        int defaultChoice, boolean multiple) {

        super(prompt, choices, defaultChoice, multiple);

    }

    private static final long serialVersionUID = -8588141348846281332L;

}