javax.security.auth.callback

Class ConfirmationCallback

  1. java.lang.Object
  2. extended byjavax.security.auth.callback.ConfirmationCallback
All implemented interfaces:
java.io.Serializable, Callback

  1. public class ConfirmationCallback
  2. extends java.lang.Object
  3. implements Callback, java.io.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.

See Also:
CallbackHandler, Serialized Form

Field Summary

Modifier and Type Field and Description
  1. static
  2. int
CANCEL
CANCEL option.
  1. static
  2. int
ERROR
ERROR message type.
  1. static
  2. int
INFORMATION
INFORMATION message type.
  1. static
  2. int
NO
NO option.
  1. static
  2. int
OK
OK option.
  1. static
  2. int
OK_CANCEL_OPTION
OK/CANCEL confirmation confirmation option.
  1. static
  2. int
UNSPECIFIED_OPTION
Unspecified option type.
  1. static
  2. int
WARNING
WARNING message type.
  1. static
  2. int
YES
YES option.
  1. static
  2. int
YES_NO_CANCEL_OPTION
YES/NO/CANCEL confirmation confirmation option.
  1. static
  2. int
YES_NO_OPTION
YES/NO confirmation option.

Constructor Summary

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,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

Modifier and Type Method and Description
  1. int
getDefaultOption()
Get the default option.
  1. int
getMessageType()
Get the message type.
  1. java.lang.String[]
getOptions()
Get the confirmation options.
  1. int
getOptionType()
Get the option type.
  1. java.lang.String
getPrompt()
Get the prompt.
  1. int
getSelectedIndex()
Get the selected confirmation option.
  1. 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

UNSPECIFIED_OPTION

  1. 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:

YES_NO_OPTION

  1. 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:

YES_NO_CANCEL_OPTION

  1. 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:

OK_CANCEL_OPTION

  1. 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:

YES

  1. 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:

NO

  1. 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:

CANCEL

  1. 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:

OK

  1. 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:

INFORMATION

  1. public static final int INFORMATION
INFORMATION message type.
See Also:

WARNING

  1. public static final int WARNING
WARNING message type.
See Also:

ERROR

  1. public static final int ERROR
ERROR message type.
See Also:

Constructor Detail

ConfirmationCallback

  1. public ConfirmationCallback(int messageType,
  2. int optionType,
  3. 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 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).
Throws:
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.

ConfirmationCallback

  1. public ConfirmationCallback(int messageType,
  2. java.lang.String[] options,
  3. 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 or ERROR).

options - the list of confirmation options.

defaultOption - the default option, represented as an index into the options array.
Throws:
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.

ConfirmationCallback

  1. public ConfirmationCallback(java.lang.String prompt,
  2. int messageType,
  3. int optionType,
  4. 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 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).
Throws:
java.lang.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.

ConfirmationCallback

  1. public ConfirmationCallback(java.lang.String prompt,
  2. int messageType,
  3. java.lang.String[] options,
  4. 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 or ERROR).

options - the list of confirmation options.

defaultOption - the default option, represented as an index into the options array.
Throws:
java.lang.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.

Method Detail

getPrompt

  1. public java.lang.String getPrompt( )
Get the prompt.

Returns:
the prompt, or null if this ConfirmationCallback was instantiated without a prompt.

getMessageType

  1. public int getMessageType()
Get the message type.

Returns:
the message type (INFORMATION, WARNING or ERROR).

getOptionType

  1. 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 or OK_CANCEL_OPTION), or UNSPECIFIED_OPTION if this ConfirmationCallback was instantiated with options instead of an optionType.

getOptions

  1. public java.lang.String[] getOptions( )
Get the confirmation options.

Returns:
the list of confirmation options, or null if this ConfirmationCallback was instantiated with an optionType instead of options.

getDefaultOption

  1. public int getDefaultOption()
Get the default option.

Returns:
the default option, represented as 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.

setSelectedIndex

  1. public void setSelectedIndex(int selection)
Set the selected confirmation option.

Parameters:
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.
See Also:

getSelectedIndex

  1. public int getSelectedIndex()
Get the selected confirmation option.

Returns:
the selected confirmation option represented as 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.
See Also: