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.
CallbackHandler
,
Serialized FormModifier and Type | Field and 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 and Description |
---|
ConfirmationCallback(int messageType,
int optionType,
int defaultOption)
Construct a
ConfirmationCallback with a
message type, an option type and a default option. |
ConfirmationCallback(int messageType,
String[] options,
int defaultOption)
Construct a
ConfirmationCallback with a
message type, a list of options and a default option. |
ConfirmationCallback(String prompt,
int messageType,
int optionType,
int defaultOption)
Construct a
ConfirmationCallback with a prompt,
message type, an option type and a default option. |
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. |
Modifier and Type | Method and 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.
|
public static final int UNSPECIFIED_OPTION
The getOptionType
method returns this
value if this ConfirmationCallback
was instantiated
with options
instead of an optionType
.
public static final int YES_NO_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
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
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
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
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
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
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
public static final int WARNING
public static final int ERROR
public ConfirmationCallback(int messageType, int optionType, int defaultOption)
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.
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
).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 defaultOption
does not correspond to one of the options in
optionType
.public ConfirmationCallback(int messageType, String[] options, int defaultOption)
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.
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.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)
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.
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
).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)
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.
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.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
.public String getPrompt()
ConfirmationCallback
was instantiated without a prompt
.public int getMessageType()
INFORMATION
,
WARNING
or ERROR
).public int getOptionType()
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.
YES_NO_OPTION
,
YES_NO_CANCEL_OPTION
or
OK_CANCEL_OPTION
), or
UNSPECIFIED_OPTION
if this
ConfirmationCallback
was instantiated with
options
instead of an optionType
.public String[] getOptions()
ConfirmationCallback
was instantiated with
an optionType
instead of options
.public int getDefaultOption()
YES
, NO
, OK
or
CANCEL
if an optionType
was specified to the constructor of this
ConfirmationCallback
.
Otherwise, this method returns the default option as
an index into the
options
array specified to the constructor
of this ConfirmationCallback
.public void setSelectedIndex(int selection)
selection
- the selection represented as YES
,
NO
, OK
or CANCEL
if an optionType
was specified to the constructor
of this ConfirmationCallback
.
Otherwise, the selection represents the index into the
options
array specified to the constructor
of this ConfirmationCallback
.getSelectedIndex()
public int getSelectedIndex()
YES
, NO
, OK
or
CANCEL
if an optionType
was specified to the constructor of this
ConfirmationCallback
.
Otherwise, this method returns the selected confirmation
option as an index into the
options
array specified to the constructor
of this ConfirmationCallback
.setSelectedIndex(int)
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.