javax.security.sasl

Class RealmChoiceCallback

java.lang.Object

javax.security.auth.callback.ChoiceCallback

javax.security.sasl.RealmChoiceCallback

All Implemented Interfaces:

Serializable, Callback

public class RealmChoiceCallback
extends ChoiceCallback

This callback is used by SaslClient and SaslServer to obtain a realm given a list of realm choices.

Since:

1.5

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RealmChoiceCallback(String prompt, String[] choices, int defaultChoice, boolean multiple) Constructs a RealmChoiceCallback with a prompt, a list of choices and a default choice.

Method Summary

Methods inherited from class javax.security.auth.callback.ChoiceCallback

allowMultipleSelections, getChoices, getDefaultChoice, getPrompt, getSelectedIndexes, setSelectedIndex, setSelectedIndexes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RealmChoiceCallback

public RealmChoiceCallback(String prompt,
                   String[] choices,
                   int defaultChoice,
                   boolean multiple)

Constructs a RealmChoiceCallback with a prompt, a list of choices and a default choice.

Parameters:

prompt - the non-null prompt to use to request the realm.

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

defaultChoice - the choice to be used as the default when the list of choices is displayed. It is an index into the choices array.

multiple - true if multiple choices allowed; false otherwise.

Throws:

IllegalArgumentException - if prompt is null or empty, if choices has a length of 0, if any element from choices is null or empty, or if defaultChoice does not fall within the array boundary of choices.