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

All Implemented Interfaces:
    Callback, Serializable

Underlying security services instantiate and pass a ConfirmationCallback to the handle method of a CallbackHandler to ask for YES/NO, OK/CANCEL, YES/NO/CANCEL or other similar confirmations.

Field Summary
public static final  int UNSPECIFIED_OPTION    Unspecified option type.

The getOptionType method returns this value if this ConfirmationCallback was instantiated with options instead of an optionType

public static final  int YES_NO_OPTION    YES/NO confirmation option.

An underlying security service specifies this as the optionType to a ConfirmationCallback constructor if it requires a confirmation which can be answered with either YES or NO

public static final  int YES_NO_CANCEL_OPTION    YES/NO/CANCEL confirmation confirmation option.

An underlying security service specifies this as the optionType to a ConfirmationCallback constructor if it requires a confirmation which can be answered with either YES, NO or CANCEL

public static final  int OK_CANCEL_OPTION    OK/CANCEL confirmation confirmation option.

An underlying security service specifies this as the optionType to a ConfirmationCallback constructor if it requires a confirmation which can be answered with either OK or CANCEL

public static final  int YES    YES option.

If an optionType was specified to this ConfirmationCallback, this option may be specified as a defaultOption or returned as the selected index. 

public static final  int NO    NO option.

If an optionType was specified to this ConfirmationCallback, this option may be specified as a defaultOption or returned as the selected index. 

public static final  int CANCEL    CANCEL option.

If an optionType was specified to this ConfirmationCallback, this option may be specified as a defaultOption or returned as the selected index. 

public static final  int OK    OK option.

If an optionType was specified to this ConfirmationCallback, this option may be specified as a defaultOption or returned as the selected index. 

public static final  int INFORMATION    INFORMATION message type. 
public static final  int WARNING    WARNING message type. 
public static final  int ERROR    ERROR message type. 
Constructor:
 public ConfirmationCallback(int messageType,
    int optionType,
    int defaultOption) 
 public ConfirmationCallback(int messageType,
    String[] options,
    int defaultOption) 
    Construct a ConfirmationCallback with a message type, a list of options and a default option.

    Underlying security services use this constructor if they require a confirmation different from the available preset confirmations provided (for example, CONTINUE/ABORT or STOP/GO). The confirmation options are listed in the options array, and are displayed by the CallbackHandler implementation in a manner consistent with the way preset options are displayed.

    Parameters:
    messageType - the message type (INFORMATION, WARNING or ERROR).


    options - the list of confirmation options.


    defaultOption - the default option, represented as an index into the options array.
    Throws:
    IllegalArgumentException - if messageType is not either INFORMATION, WARNING, or ERROR, if options is null, if options has a length of 0, if any element from options is null, if any element from options has a length of 0, or if defaultOption does not lie within the array boundaries of options.
    exception: IllegalArgumentException - if messageType is not either INFORMATION, WARNING, or ERROR, if options is null, if options has a length of 0, if any element from options is null, if any element from options has a length of 0, or if defaultOption does not lie within the array boundaries of options.
 public ConfirmationCallback(String prompt,
    int messageType,
    int optionType,
    int defaultOption) 
    Construct a ConfirmationCallback with a prompt, message type, an option type and a default option.

    Underlying security services use this constructor if they require either a YES/NO, YES/NO/CANCEL or OK/CANCEL confirmation.

    Parameters:
    prompt - the prompt used to describe the list of options.


    messageType - the message type (INFORMATION, WARNING or ERROR).


    optionType - the option type (YES_NO_OPTION, YES_NO_CANCEL_OPTION or OK_CANCEL_OPTION).


    defaultOption - the default option from the provided optionType (YES, NO, CANCEL or OK).
    Throws:
    IllegalArgumentException - if prompt is null, if prompt has a length of 0, if messageType is not either INFORMATION, WARNING, or ERROR, if optionType is not either YES_NO_OPTION, YES_NO_CANCEL_OPTION, or OK_CANCEL_OPTION, or if defaultOption does not correspond to one of the options in optionType.
    exception: IllegalArgumentException - if prompt is null, if prompt has a length of 0, if messageType is not either INFORMATION, WARNING, or ERROR, if optionType is not either YES_NO_OPTION, YES_NO_CANCEL_OPTION, or OK_CANCEL_OPTION, or if defaultOption does not correspond to one of the options in optionType.
 public ConfirmationCallback(String prompt,
    int messageType,
    String[] options,
    int defaultOption) 
    Construct a ConfirmationCallback with a prompt, message type, a list of options and a default option.

    Underlying security services use this constructor if they require a confirmation different from the available preset confirmations provided (for example, CONTINUE/ABORT or STOP/GO). The confirmation options are listed in the options array, and are displayed by the CallbackHandler implementation in a manner consistent with the way preset options are displayed.

    Parameters:
    prompt - the prompt used to describe the list of options.


    messageType - the message type (INFORMATION, WARNING or ERROR).


    options - the list of confirmation options.


    defaultOption - the default option, represented as an index into the options array.
    Throws:
    IllegalArgumentException - if prompt is null, if prompt has a length of 0, if messageType is not either INFORMATION, WARNING, or ERROR, if options is null, if options has a length of 0, if any element from options is null, if any element from options has a length of 0, or if defaultOption does not lie within the array boundaries of options.
    exception: IllegalArgumentException - if prompt is null, if prompt has a length of 0, if messageType is not either INFORMATION, WARNING, or ERROR, if options is null, if options has a length of 0, if any element from options is null, if any element from options has a length of 0, or if defaultOption does not lie within the array boundaries of options.
Method from javax.security.auth.callback.ConfirmationCallback Summary:
getDefaultOption,   getMessageType,   getOptionType,   getOptions,   getPrompt,   getSelectedIndex,   setSelectedIndex
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.security.auth.callback.ConfirmationCallback Detail:
 public int getDefaultOption() 
    Get the default option.

 public int getMessageType() 
    Get the message type.

 public int getOptionType() 
    Get the option type.

    If this method returns UNSPECIFIED_OPTION, then this ConfirmationCallback was instantiated with options instead of an optionType. In this case, invoke the getOptions method to determine which confirmation options to display.

 public String[] getOptions() 
    Get the confirmation options.

 public String getPrompt() 
    Get the prompt.

 public int getSelectedIndex() 
    Get the selected confirmation option.

 public  void setSelectedIndex(int selection) 
    Set the selected confirmation option.