|
For the latest news and information visit The GNU Crypto project |
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Object | +--javax.security.auth.callback.ConfirmationCallback
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 Form| Field Summary | |
|---|---|
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 | |
|---|---|
ConfirmationCallback(int messageType,
int optionType,
int defaultOption)
Construct a ConfirmationCallback with a message type, an
option type and a default option. |
|
ConfirmationCallback(int messageType,
java.lang.String[] options,
int defaultOption)
Construct a ConfirmationCallback with a message type, a
list of options and a default option. |
|
ConfirmationCallback(java.lang.String prompt,
int messageType,
int optionType,
int defaultOption)
Construct a ConfirmationCallback with a prompt, message
type, an option type and a default option. |
|
ConfirmationCallback(java.lang.String prompt,
int messageType,
java.lang.String[] options,
int defaultOption)
Construct a ConfirmationCallback with a prompt, message
type, a list of options and a default option. |
|
| Method Summary | |
|---|---|
int |
getDefaultOption()
Get the default option. |
int |
getMessageType()
Get the message type. |
java.lang.String[] |
getOptions()
Get the confirmation options. |
int |
getOptionType()
Get the option type. |
java.lang.String |
getPrompt()
Get the prompt. |
int |
getSelectedIndex()
Get the selected confirmation option. |
void |
setSelectedIndex(int selection)
Set the selected confirmation option. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
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
public static final int WARNING
public static final int ERROR
| Constructor Detail |
public ConfirmationCallback(int messageType,
int optionType,
int defaultOption)
throws java.lang.IllegalArgumentException
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.
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).
java.lang.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,
java.lang.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.
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.
java.lang.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(java.lang.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.
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).
java.lang.IllegalArgumentException - if prompt is null,
if prompt has a length of 0, if
messageType is not either 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(java.lang.String prompt,
int messageType,
java.lang.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.
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.
java.lang.IllegalArgumentException - if prompt is null,
if prompt has a length of 0, if
messageType is not either 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 Detail |
public java.lang.String getPrompt()
null if this
ConfirmationCallback was instantiated without a prompt.public int getMessageType()
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.
ConfirmationCallback was instantiated with options
instead of an optionType.public java.lang.String[] getOptions()
null if this
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)
|
For the latest news and information visit The GNU Crypto project |
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||