Class ConfirmationCallback
- 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 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:
-
CallbackHandler
, Serialized Form
Field Summary
Modifier and Type | Field | Description |
---|---|---|
static int | CANCEL | CANCEL option. |
static int | ERROR | ERROR message type. |
static int | INFORMATION | INFORMATION message type. |
static int | NO | NO option. |
static int | OK | OK option. |
static int | OK_CANCEL_OPTION | OK/CANCEL confirmation confirmation option. |
static int | UNSPECIFIED_OPTION | Unspecified option type. |
static int | WARNING | WARNING message type. |
static int | YES | YES option. |
static int | YES_NO_CANCEL_OPTION | YES/NO/CANCEL confirmation confirmation option. |
static int | YES_NO_OPTION | YES/NO confirmation option. |
Constructor Summary
Constructor | Description |
---|---|
ConfirmationCallback(int messageType,
int optionType,
int defaultOption) | Construct a |
ConfirmationCallback(int messageType,
String[] options,
int defaultOption) | Construct a |
ConfirmationCallback(String prompt,
int messageType,
int optionType,
int defaultOption) | Construct a |
ConfirmationCallback(String prompt,
int messageType,
String[] options,
int defaultOption) | Construct a |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
int | getDefaultOption() | Get the default option. |
int | getMessageType() | Get the message type. |
String[] | getOptions() | Get the confirmation options. |
int | getOptionType() | Get the option type. |
String | getPrompt() | Get the prompt. |
int | getSelectedIndex() | Get the selected confirmation option. |
void | setSelectedIndex(int selection) | Set the selected confirmation option. |
Methods declared in class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Field Detail
UNSPECIFIED_OPTION
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
.
- See Also:
- Constant Field Values
YES_NO_OPTION
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
.
- See Also:
- Constant Field Values
YES_NO_CANCEL_OPTION
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
.
- See Also:
- Constant Field Values
OK_CANCEL_OPTION
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
.
- See Also:
- Constant Field Values
YES
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.
- See Also:
- Constant Field Values
NO
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.
- See Also:
- Constant Field Values
CANCEL
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.
- See Also:
- Constant Field Values
OK
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.
- See Also:
- Constant Field Values
INFORMATION
public static final int INFORMATION
INFORMATION message type.
- See Also:
- Constant Field Values
WARNING
public static final int WARNING
WARNING message type.
- See Also:
- Constant Field Values
ERROR
public static final int ERROR
ERROR message type.
- See Also:
- Constant Field Values
Constructor Detail
ConfirmationCallback
public ConfirmationCallback(int messageType, int optionType, int defaultOption)
Construct a ConfirmationCallback
with 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
,WARNING
orERROR
). -
optionType
- the option type (YES_NO_OPTION
,YES_NO_CANCEL_OPTION
orOK_CANCEL_OPTION
). -
defaultOption
- the default option from the provided optionType (YES
,NO
,CANCEL
orOK
). - Throws:
-
IllegalArgumentException
- if messageType is not eitherINFORMATION
,WARNING
, orERROR
, if optionType is not eitherYES_NO_OPTION
,YES_NO_CANCEL_OPTION
, orOK_CANCEL_OPTION
, or ifdefaultOption
does not correspond to one of the options inoptionType
.
ConfirmationCallback
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
orERROR
). -
options
- the list of confirmation options. -
defaultOption
- the default option, represented as an index into theoptions
array. - Throws:
-
IllegalArgumentException
- if messageType is not eitherINFORMATION
,WARNING
, orERROR
, ifoptions
is null, ifoptions
has a length of 0, if any element fromoptions
is null, if any element fromoptions
has a length of 0, or ifdefaultOption
does not lie within the array boundaries ofoptions
.
ConfirmationCallback
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
orERROR
). -
optionType
- the option type (YES_NO_OPTION
,YES_NO_CANCEL_OPTION
orOK_CANCEL_OPTION
). -
defaultOption
- the default option from the provided optionType (YES
,NO
,CANCEL
orOK
). - Throws:
-
IllegalArgumentException
- ifprompt
is null, ifprompt
has 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 ifdefaultOption
does not correspond to one of the options inoptionType
.
ConfirmationCallback
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
orERROR
). -
options
- the list of confirmation options. -
defaultOption
- the default option, represented as an index into theoptions
array. - Throws:
-
IllegalArgumentException
- ifprompt
is null, ifprompt
has a length of 0, if messageType is not eitherINFORMATION
,WARNING
, orERROR
, ifoptions
is null, ifoptions
has a length of 0, if any element fromoptions
is null, if any element fromoptions
has a length of 0, or ifdefaultOption
does not lie within the array boundaries ofoptions
.
Method Detail
getPrompt
public String getPrompt()
Get the prompt.
- Returns:
- the prompt, or null if this
ConfirmationCallback
was instantiated without aprompt
.
getMessageType
public int getMessageType()
Get the message type.
- Returns:
- the message type (
INFORMATION
,WARNING
orERROR
).
getOptionType
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.
- Returns:
- the option type (
YES_NO_OPTION
,YES_NO_CANCEL_OPTION
orOK_CANCEL_OPTION
), orUNSPECIFIED_OPTION
if thisConfirmationCallback
was instantiated withoptions
instead of anoptionType
.
getOptions
public String[] getOptions()
Get the confirmation options.
- Returns:
- the list of confirmation options, or null if this
ConfirmationCallback
was instantiated with anoptionType
instead ofoptions
.
getDefaultOption
public int getDefaultOption()
Get the default option.
- Returns:
- the default option, represented as
YES
,NO
,OK
orCANCEL
if anoptionType
was specified to the constructor of thisConfirmationCallback
. Otherwise, this method returns the default option as an index into theoptions
array specified to the constructor of thisConfirmationCallback
.
setSelectedIndex
public void setSelectedIndex(int selection)
Set the selected confirmation option.
- Parameters:
-
selection
- the selection represented asYES
,NO
,OK
orCANCEL
if anoptionType
was specified to the constructor of thisConfirmationCallback
. Otherwise, the selection represents the index into theoptions
array specified to the constructor of thisConfirmationCallback
. - See Also:
getSelectedIndex()
getSelectedIndex
public int getSelectedIndex()
Get the selected confirmation option.
- Returns:
- the selected confirmation option represented as
YES
,NO
,OK
orCANCEL
if anoptionType
was specified to the constructor of thisConfirmationCallback
. Otherwise, this method returns the selected confirmation option as an index into theoptions
array specified to the constructor of thisConfirmationCallback
. - See Also:
setSelectedIndex(int)