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 SummaryConstructorsConstructorDescriptionChoiceCallback(String prompt, String[] choices, int defaultChoice, boolean multipleSelectionsAllowed) Construct aChoiceCallbackwith a prompt, a list of choices, a default choice, and a boolean specifying whether multiple selections from the list of choices are allowed.
- 
Method SummaryModifier and TypeMethodDescriptionbooleanGet the boolean determining whether multiple selections from thechoiceslist are allowed.String[]Get the list of choices.intGet the defaultChoice.Get the prompt.int[]Get the selected choices.voidsetSelectedIndex(int selection) Set the selected choice.voidsetSelectedIndexes(int[] selections) Set the selected choices.
- 
Constructor Details- 
ChoiceCallbackpublic ChoiceCallback(String prompt, String[] choices, int defaultChoice, boolean multipleSelectionsAllowed) Construct aChoiceCallbackwith 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 the- choicesarray.
- multipleSelectionsAllowed- boolean specifying whether multiple selections can be made from the list of choices.
- Throws:
- IllegalArgumentException- if- promptis null, if- prompthas a length of 0, if- choicesis null, if- choiceshas a length of 0, if any element from- choicesis null, if any element from- choiceshas a length of 0 or if- defaultChoicedoes not fall within the array boundaries of- choices.
 
 
- 
- 
Method Details- 
getPromptGet the prompt.- Returns:
- the prompt.
 
- 
getChoicesGet the list of choices.- Returns:
- a copy of the list of choices.
 
- 
getDefaultChoicepublic int getDefaultChoice()Get the defaultChoice.- Returns:
- the defaultChoice, represented as an index into
          the choiceslist.
 
- 
allowMultipleSelectionspublic boolean allowMultipleSelections()Get the boolean determining whether multiple selections from thechoiceslist are allowed.- Returns:
- whether multiple selections are allowed.
 
- 
setSelectedIndexpublic void setSelectedIndex(int selection) Set the selected choice.- Parameters:
- selection- the selection represented as an index into the- choiceslist.
- See Also:
 
- 
setSelectedIndexespublic void setSelectedIndexes(int[] selections) Set the selected choices.- Parameters:
- selections- the selections represented as indexes into the- choiceslist. The array is cloned to protect against subsequent modification.
- Throws:
- UnsupportedOperationException- if multiple selections are not allowed, as determined by- allowMultipleSelections.
- See Also:
 
- 
getSelectedIndexespublic int[] getSelectedIndexes()Get the selected choices.- Returns:
- a copy of the selected choices, represented as indexes into the
          choiceslist.
- See Also:
 
 
-