- All Implemented Interfaces:
Serializable,Callback
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.
- Since:
- 1.4
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intCANCEL option.static final intERROR message type.static final intINFORMATION message type.static final intNO option.static final intOK option.static final intOK/CANCEL confirmation option.static final intUnspecified option type.static final intWARNING message type.static final intYES option.static final intYES/NO/CANCEL confirmation option.static final intYES/NO confirmation option. -
Constructor Summary
ConstructorsConstructorDescriptionConfirmationCallback(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 Summary
Modifier and TypeMethodDescriptionintGet the default option.intGet the message type.String[]Get the confirmation options.intGet the option type.Get the prompt.intGet the selected confirmation option.voidsetSelectedIndex(int selection) Set the selected confirmation option.
-
Field Details
-
UNSPECIFIED_OPTION
public static final int UNSPECIFIED_OPTIONUnspecified option type.The
getOptionTypemethod returns this value if thisConfirmationCallbackwas instantiated withoptionsinstead of anoptionType.- See Also:
-
YES_NO_OPTION
public static final int YES_NO_OPTIONYES/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:
-
YES_NO_CANCEL_OPTION
public static final int YES_NO_CANCEL_OPTIONYES/NO/CANCEL 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:
-
OK_CANCEL_OPTION
public static final int OK_CANCEL_OPTIONOK/CANCEL 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:
-
YES
public static final int YESYES option.If an
optionTypewas specified to thisConfirmationCallback, this option may be specified as adefaultOptionor returned as the selected index.- See Also:
-
NO
public static final int NONO option.If an
optionTypewas specified to thisConfirmationCallback, this option may be specified as adefaultOptionor returned as the selected index.- See Also:
-
CANCEL
public static final int CANCELCANCEL option.If an
optionTypewas specified to thisConfirmationCallback, this option may be specified as adefaultOptionor returned as the selected index.- See Also:
-
OK
public static final int OKOK option.If an
optionTypewas specified to thisConfirmationCallback, this option may be specified as adefaultOptionor returned as the selected index.- See Also:
-
INFORMATION
public static final int INFORMATIONINFORMATION message type.- See Also:
-
WARNING
public static final int WARNINGWARNING message type.- See Also:
-
ERROR
public static final int ERRORERROR message type.- See Also:
-
-
Constructor Details
-
ConfirmationCallback
public 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,WARNINGorERROR).optionType- the option type (YES_NO_OPTION,YES_NO_CANCEL_OPTIONorOK_CANCEL_OPTION).defaultOption- the default option from the provided optionType (YES,NO,CANCELorOK).- Throws:
IllegalArgumentException- if messageType is not eitherINFORMATION,WARNING, orERROR, if optionType is not eitherYES_NO_OPTION,YES_NO_CANCEL_OPTION, orOK_CANCEL_OPTION, or ifdefaultOptiondoes not correspond to one of the options inoptionType.
-
ConfirmationCallback
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,WARNINGorERROR).options- the list of confirmation options. The array is cloned to protect against subsequent modification.defaultOption- the default option, represented as an index into theoptionsarray.- Throws:
IllegalArgumentException- if messageType is not eitherINFORMATION,WARNING, orERROR, ifoptionsis null, ifoptionshas a length of 0, if any element fromoptionsis null, if any element fromoptionshas a length of 0, or ifdefaultOptiondoes not lie within the array boundaries ofoptions.
-
ConfirmationCallback
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,WARNINGorERROR).optionType- the option type (YES_NO_OPTION,YES_NO_CANCEL_OPTIONorOK_CANCEL_OPTION).defaultOption- the default option from the provided optionType (YES,NO,CANCELorOK).- Throws:
IllegalArgumentException- ifpromptis null, ifprompthas a length of 0, if messageType is not eitherINFORMATION,WARNING, orERROR, if optionType is not eitherYES_NO_OPTION,YES_NO_CANCEL_OPTION, orOK_CANCEL_OPTION, or ifdefaultOptiondoes not correspond to one of the options inoptionType.
-
ConfirmationCallback
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,WARNINGorERROR).options- the list of confirmation options. The array is cloned to protect against subsequent modification.defaultOption- the default option, represented as an index into theoptionsarray.- Throws:
IllegalArgumentException- ifpromptis null, ifprompthas a length of 0, if messageType is not eitherINFORMATION,WARNING, orERROR, ifoptionsis null, ifoptionshas a length of 0, if any element fromoptionsis null, if any element fromoptionshas a length of 0, or ifdefaultOptiondoes not lie within the array boundaries ofoptions.
-
-
Method Details
-
getPrompt
Get the prompt.- Returns:
- the prompt, or null if this
ConfirmationCallbackwas instantiated without aprompt.
-
getMessageType
public int getMessageType()Get the message type.- Returns:
- the message type (
INFORMATION,WARNINGorERROR).
-
getOptionType
public 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.
-
getOptions
Get the confirmation options.- Returns:
- a copy of the list of confirmation options, or null if this
ConfirmationCallbackwas instantiated with anoptionTypeinstead ofoptions.
-
getDefaultOption
public 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.
-
setSelectedIndex
public void setSelectedIndex(int selection) Set the selected confirmation option.- Parameters:
selection- the selection represented asYES,NO,OKorCANCELif anoptionTypewas specified to the constructor of thisConfirmationCallback. Otherwise, the selection represents the index into theoptionsarray specified to the constructor of thisConfirmationCallback.- See Also:
-
getSelectedIndex
public 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:
-