- java.lang.Object
- 
- javax.security.auth.callback.ConfirmationCallback
 
- 
- All Implemented Interfaces:
- Serializable,- Callback
 
 public class ConfirmationCallback extends Object implements Callback, Serializable Underlying security services instantiate and pass a ConfirmationCallbackto thehandlemethod of aCallbackHandlerto ask for YES/NO, OK/CANCEL, YES/NO/CANCEL or other similar confirmations.- Since:
- 1.4
- See Also:
- CallbackHandler, Serialized Form
 
- 
- 
Field SummaryFields Modifier and Type Field Description static intCANCELCANCEL option.static intERRORERROR message type.static intINFORMATIONINFORMATION message type.static intNONO option.static intOKOK option.static intOK_CANCEL_OPTIONOK/CANCEL confirmation confirmation option.static intUNSPECIFIED_OPTIONUnspecified option type.static intWARNINGWARNING message type.static intYESYES option.static intYES_NO_CANCEL_OPTIONYES/NO/CANCEL confirmation confirmation option.static intYES_NO_OPTIONYES/NO confirmation option.
 - 
Constructor SummaryConstructors Constructor Description ConfirmationCallback(int messageType, int optionType, int defaultOption)Construct aConfirmationCallbackwith a message type, an option type and a default option.ConfirmationCallback(int messageType, String[] options, int defaultOption)Construct aConfirmationCallbackwith a message type, a list of options and a default option.ConfirmationCallback(String prompt, int messageType, int optionType, int defaultOption)Construct aConfirmationCallbackwith a prompt, message type, an option type and a default option.ConfirmationCallback(String prompt, int messageType, String[] options, int defaultOption)Construct aConfirmationCallbackwith a prompt, message type, a list of options and a default option.
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description intgetDefaultOption()Get the default option.intgetMessageType()Get the message type.String[]getOptions()Get the confirmation options.intgetOptionType()Get the option type.StringgetPrompt()Get the prompt.intgetSelectedIndex()Get the selected confirmation option.voidsetSelectedIndex(int selection)Set the selected confirmation option.
 
- 
- 
- 
Field Detail- 
UNSPECIFIED_OPTIONpublic static final int UNSPECIFIED_OPTION Unspecified option type.The getOptionTypemethod returns this value if thisConfirmationCallbackwas instantiated withoptionsinstead of anoptionType.- See Also:
- Constant Field Values
 
 - 
YES_NO_OPTIONpublic static final int YES_NO_OPTION YES/NO confirmation option.An underlying security service specifies this as the optionTypeto aConfirmationCallbackconstructor if it requires a confirmation which can be answered with eitherYESorNO.- See Also:
- Constant Field Values
 
 - 
YES_NO_CANCEL_OPTIONpublic static final int YES_NO_CANCEL_OPTION YES/NO/CANCEL confirmation confirmation option.An underlying security service specifies this as the optionTypeto aConfirmationCallbackconstructor if it requires a confirmation which can be answered with eitherYES,NOorCANCEL.- See Also:
- Constant Field Values
 
 - 
OK_CANCEL_OPTIONpublic static final int OK_CANCEL_OPTION OK/CANCEL confirmation confirmation option.An underlying security service specifies this as the optionTypeto aConfirmationCallbackconstructor if it requires a confirmation which can be answered with eitherOKorCANCEL.- See Also:
- Constant Field Values
 
 - 
YESpublic static final int YES YES option.If an optionTypewas specified to thisConfirmationCallback, this option may be specified as adefaultOptionor returned as the selected index.- See Also:
- Constant Field Values
 
 - 
NOpublic static final int NO NO option.If an optionTypewas specified to thisConfirmationCallback, this option may be specified as adefaultOptionor returned as the selected index.- See Also:
- Constant Field Values
 
 - 
CANCELpublic static final int CANCEL CANCEL option.If an optionTypewas specified to thisConfirmationCallback, this option may be specified as adefaultOptionor returned as the selected index.- See Also:
- Constant Field Values
 
 - 
OKpublic static final int OK OK option.If an optionTypewas specified to thisConfirmationCallback, this option may be specified as adefaultOptionor returned as the selected index.- See Also:
- Constant Field Values
 
 - 
INFORMATIONpublic static final int INFORMATION INFORMATION message type.- See Also:
- Constant Field Values
 
 - 
WARNINGpublic static final int WARNING WARNING message type.- See Also:
- Constant Field Values
 
 - 
ERRORpublic static final int ERROR ERROR message type.- See Also:
- Constant Field Values
 
 
- 
 - 
Constructor Detail- 
ConfirmationCallbackpublic ConfirmationCallback(int messageType, int optionType, int defaultOption)Construct aConfirmationCallbackwith a 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:
- messageType- the message type (- INFORMATION,- WARNINGor- ERROR).
- optionType- the option type (- YES_NO_OPTION,- YES_NO_CANCEL_OPTIONor- OK_CANCEL_OPTION).
- defaultOption- the default option from the provided optionType (- YES,- NO,- CANCELor- OK).
- Throws:
- IllegalArgumentException- 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- defaultOptiondoes not correspond to one of the options in- optionType.
 
 - 
ConfirmationCallbackpublic ConfirmationCallback(int messageType, String[] options, int defaultOption)Construct aConfirmationCallbackwith 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 optionsarray, and are displayed by theCallbackHandlerimplementation in a manner consistent with the way preset options are displayed.- Parameters:
- messageType- the message type (- INFORMATION,- WARNINGor- ERROR).
- options- the list of confirmation options.
- defaultOption- the default option, represented as an index into the- optionsarray.
- Throws:
- IllegalArgumentException- if messageType is not either- INFORMATION,- WARNING, or- ERROR, if- optionsis null, if- optionshas a length of 0, if any element from- optionsis null, if any element from- optionshas a length of 0, or if- defaultOptiondoes not lie within the array boundaries of- options.
 
 - 
ConfirmationCallbackpublic ConfirmationCallback(String prompt, int messageType, int optionType, int defaultOption) Construct aConfirmationCallbackwith 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,- WARNINGor- ERROR).
- optionType- the option type (- YES_NO_OPTION,- YES_NO_CANCEL_OPTIONor- OK_CANCEL_OPTION).
- defaultOption- the default option from the provided optionType (- YES,- NO,- CANCELor- OK).
- Throws:
- IllegalArgumentException- if- promptis null, if- prompthas 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- defaultOptiondoes not correspond to one of the options in- optionType.
 
 - 
ConfirmationCallbackpublic ConfirmationCallback(String prompt, int messageType, String[] options, int defaultOption) Construct aConfirmationCallbackwith 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 optionsarray, and are displayed by theCallbackHandlerimplementation 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,- WARNINGor- ERROR).
- options- the list of confirmation options.
- defaultOption- the default option, represented as an index into the- optionsarray.
- Throws:
- IllegalArgumentException- if- promptis null, if- prompthas a length of 0, if messageType is not either- INFORMATION,- WARNING, or- ERROR, if- optionsis null, if- optionshas a length of 0, if any element from- optionsis null, if any element from- optionshas a length of 0, or if- defaultOptiondoes not lie within the array boundaries of- options.
 
 
- 
 - 
Method Detail- 
getPromptpublic String getPrompt() Get the prompt.- Returns:
- the prompt, or null if this ConfirmationCallbackwas instantiated without aprompt.
 
 - 
getMessageTypepublic int getMessageType() Get the message type.- Returns:
- the message type (INFORMATION,WARNINGorERROR).
 
 - 
getOptionTypepublic int getOptionType() Get the option type.If this method returns UNSPECIFIED_OPTION, then thisConfirmationCallbackwas instantiated withoptionsinstead of anoptionType. In this case, invoke thegetOptionsmethod to determine which confirmation options to display.- Returns:
- the option type (YES_NO_OPTION,YES_NO_CANCEL_OPTIONorOK_CANCEL_OPTION), orUNSPECIFIED_OPTIONif thisConfirmationCallbackwas instantiated withoptionsinstead of anoptionType.
 
 - 
getOptionspublic String[] getOptions() Get the confirmation options.- Returns:
- the list of confirmation options, or null if this
          ConfirmationCallbackwas instantiated with anoptionTypeinstead ofoptions.
 
 - 
getDefaultOptionpublic int getDefaultOption() Get the default option.- Returns:
- the default option, represented as
          YES,NO,OKorCANCELif anoptionTypewas specified to the constructor of thisConfirmationCallback. Otherwise, this method returns the default option as an index into theoptionsarray specified to the constructor of thisConfirmationCallback.
 
 - 
setSelectedIndexpublic void setSelectedIndex(int selection) Set the selected confirmation option.- Parameters:
- selection- the selection represented as- YES,- NO,- OKor- CANCELif an- optionTypewas specified to the constructor of this- ConfirmationCallback. Otherwise, the selection represents the index into the- optionsarray specified to the constructor of this- ConfirmationCallback.
- See Also:
- getSelectedIndex()
 
 - 
getSelectedIndexpublic int getSelectedIndex() Get the selected confirmation option.- Returns:
- the selected confirmation option represented as
          YES,NO,OKorCANCELif anoptionTypewas specified to the constructor of thisConfirmationCallback. Otherwise, this method returns the selected confirmation option as an index into theoptionsarray specified to the constructor of thisConfirmationCallback.
- See Also:
- setSelectedIndex(int)
 
 
- 
 
-