Home » openjdk-7 » javax.security » auth » callback » [javadoc | source]
javax.security.auth.callback
public class: ChoiceCallback [javadoc | source]
java.lang.Object
   javax.security.auth.callback.ChoiceCallback

All Implemented Interfaces:
    Callback, java$io$Serializable

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).

Constructor:
 public ChoiceCallback(String prompt,
    String[] choices,
    int defaultChoice,
    boolean multipleSelectionsAllowed) 
    Construct a ChoiceCallback with a prompt, a list of choices, a default choice, and a boolean specifying whether or not 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.


    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 choices array.


    multipleSelectionsAllowed - boolean specifying whether or not multiple selections can be made from the list of choices.
    Throws:
    IllegalArgumentException - if prompt is null, if prompt has a length of 0, if choices is null, if choices has a length of 0, if any element from choices is null, if any element from choices has a length of 0 or if defaultChoice does not fall within the array boundaries of choices.
    exception: IllegalArgumentException - if prompt is null, if prompt has a length of 0, if choices is null, if choices has a length of 0, if any element from choices is null, if any element from choices has a length of 0 or if defaultChoice does not fall within the array boundaries of choices.
Method from javax.security.auth.callback.ChoiceCallback Summary:
allowMultipleSelections,   getChoices,   getDefaultChoice,   getPrompt,   getSelectedIndexes,   setSelectedIndex,   setSelectedIndexes
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.security.auth.callback.ChoiceCallback Detail:
 public boolean allowMultipleSelections() 
    Get the boolean determining whether multiple selections from the choices list are allowed.

 public String[] getChoices() 
    Get the list of choices.

 public int getDefaultChoice() 
    Get the defaultChoice.

 public String getPrompt() 
    Get the prompt.

 public int[] getSelectedIndexes() 
    Get the selected choices.

 public  void setSelectedIndex(int selection) 
    Set the selected choice.

 public  void setSelectedIndexes(int[] selections) 
    Set the selected choices.