java.lang.Object
javax.security.auth.callback.ChoiceCallback
- All Implemented Interfaces:
Serializable
,Callback
- Direct Known Subclasses:
RealmChoiceCallback
Underlying security services instantiate and pass a
ChoiceCallback
to the handle
method of a CallbackHandler
to display a list of choices
and to retrieve the selected choice(s).
- Since:
- 1.4
- See Also:
-
Constructor Summary
ConstructorDescriptionChoiceCallback
(String prompt, String[] choices, int defaultChoice, boolean multipleSelectionsAllowed) Construct aChoiceCallback
with a prompt, a list of choices, a default choice, and a boolean specifying whether multiple selections from the list of choices are allowed. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Get the boolean determining whether multiple selections from thechoices
list are allowed.String[]
Get the list of choices.int
Get the defaultChoice.Get the prompt.int[]
Get the selected choices.void
setSelectedIndex
(int selection) Set the selected choice.void
setSelectedIndexes
(int[] selections) Set the selected choices.
-
Constructor Details
-
ChoiceCallback
public ChoiceCallback(String prompt, String[] choices, int defaultChoice, boolean multipleSelectionsAllowed) Construct aChoiceCallback
with a prompt, a list of choices, a default choice, and a boolean specifying whether multiple selections from the list of choices are allowed.- Parameters:
prompt
- the prompt used to describe the list of choices.choices
- the list of choices. The array is cloned to protect against subsequent modification.defaultChoice
- the choice to be used as the default choice when the list of choices are displayed. This value is represented as an index into thechoices
array.multipleSelectionsAllowed
- boolean specifying whether multiple selections can be made from the list of choices.- Throws:
IllegalArgumentException
- ifprompt
is null, ifprompt
has a length of 0, ifchoices
is null, ifchoices
has a length of 0, if any element fromchoices
is null, if any element fromchoices
has a length of 0 or ifdefaultChoice
does not fall within the array boundaries ofchoices
.
-
-
Method Details
-
getPrompt
Get the prompt.- Returns:
- the prompt.
-
getChoices
Get the list of choices.- Returns:
- a copy of the list of choices.
-
getDefaultChoice
public int getDefaultChoice()Get the defaultChoice.- Returns:
- the defaultChoice, represented as an index into
the
choices
list.
-
allowMultipleSelections
public boolean allowMultipleSelections()Get the boolean determining whether multiple selections from thechoices
list are allowed.- Returns:
- whether multiple selections are allowed.
-
setSelectedIndex
public void setSelectedIndex(int selection) Set the selected choice.- Parameters:
selection
- the selection represented as an index into thechoices
list.- See Also:
-
setSelectedIndexes
public void setSelectedIndexes(int[] selections) Set the selected choices.- Parameters:
selections
- the selections represented as indexes into thechoices
list. The array is cloned to protect against subsequent modification.- Throws:
UnsupportedOperationException
- if multiple selections are not allowed, as determined byallowMultipleSelections
.- See Also:
-
getSelectedIndexes
public int[] getSelectedIndexes()Get the selected choices.- Returns:
- a copy of the selected choices, represented as indexes into the
choices
list. - See Also:
-