javax.security.auth.callback
Class ConfirmationCallback

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by javax.security.auth.callback.ConfirmationCallback
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable , Callback sample code for javax.security.auth.callback.Callback definition code for javax.security.auth.callback.Callback

public class ConfirmationCallback
extends Object sample code for java.lang.Object definition code for java.lang.Object
implements Callback sample code for javax.security.auth.callback.Callback definition code for javax.security.auth.callback.Callback , Serializable sample code for java.io.Serializable definition code for 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 sample code for javax.security.auth.callback.CallbackHandler definition code for javax.security.auth.callback.CallbackHandler , Serialized Form

Field Summary
static int CANCEL sample code for javax.security.auth.callback.ConfirmationCallback.CANCEL definition code for javax.security.auth.callback.ConfirmationCallback.CANCEL
          CANCEL option.
static int ERROR sample code for javax.security.auth.callback.ConfirmationCallback.ERROR definition code for javax.security.auth.callback.ConfirmationCallback.ERROR
          ERROR message type.
static int INFORMATION sample code for javax.security.auth.callback.ConfirmationCallback.INFORMATION definition code for javax.security.auth.callback.ConfirmationCallback.INFORMATION
          INFORMATION message type.
static int NO sample code for javax.security.auth.callback.ConfirmationCallback.NO definition code for javax.security.auth.callback.ConfirmationCallback.NO
          NO option.
static int OK sample code for javax.security.auth.callback.ConfirmationCallback.OK definition code for javax.security.auth.callback.ConfirmationCallback.OK
          OK option.
static int OK_CANCEL_OPTION sample code for javax.security.auth.callback.ConfirmationCallback.OK_CANCEL_OPTION definition code for javax.security.auth.callback.ConfirmationCallback.OK_CANCEL_OPTION
          OK/CANCEL confirmation confirmation option.
static int UNSPECIFIED_OPTION sample code for javax.security.auth.callback.ConfirmationCallback.UNSPECIFIED_OPTION definition code for javax.security.auth.callback.ConfirmationCallback.UNSPECIFIED_OPTION
          Unspecified option type.
static int WARNING sample code for javax.security.auth.callback.ConfirmationCallback.WARNING definition code for javax.security.auth.callback.ConfirmationCallback.WARNING
          WARNING message type.
static int YES sample code for javax.security.auth.callback.ConfirmationCallback.YES definition code for javax.security.auth.callback.ConfirmationCallback.YES
          YES option.
static int YES_NO_CANCEL_OPTION sample code for javax.security.auth.callback.ConfirmationCallback.YES_NO_CANCEL_OPTION definition code for javax.security.auth.callback.ConfirmationCallback.YES_NO_CANCEL_OPTION
          YES/NO/CANCEL confirmation confirmation option.
static int YES_NO_OPTION sample code for javax.security.auth.callback.ConfirmationCallback.YES_NO_OPTION definition code for javax.security.auth.callback.ConfirmationCallback.YES_NO_OPTION
          YES/NO confirmation option.
 
Constructor Summary
ConfirmationCallback sample code for javax.security.auth.callback.ConfirmationCallback.ConfirmationCallback(int, int, int) definition code for javax.security.auth.callback.ConfirmationCallback.ConfirmationCallback(int, int, int) (int messageType, int optionType, int defaultOption)
          Construct a ConfirmationCallback with a message type, an option type and a default option.
ConfirmationCallback sample code for javax.security.auth.callback.ConfirmationCallback.ConfirmationCallback(int, java.lang.String[], int) definition code for javax.security.auth.callback.ConfirmationCallback.ConfirmationCallback(int, java.lang.String[], int) (int messageType, String sample code for java.lang.String definition code for java.lang.String [] options, int defaultOption)
          Construct a ConfirmationCallback with a message type, a list of options and a default option.
ConfirmationCallback sample code for javax.security.auth.callback.ConfirmationCallback.ConfirmationCallback(java.lang.String, int, int, int) definition code for javax.security.auth.callback.ConfirmationCallback.ConfirmationCallback(java.lang.String, int, int, int) (String sample code for java.lang.String definition code for 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 sample code for javax.security.auth.callback.ConfirmationCallback.ConfirmationCallback(java.lang.String, int, java.lang.String[], int) definition code for javax.security.auth.callback.ConfirmationCallback.ConfirmationCallback(java.lang.String, int, java.lang.String[], int) (String sample code for java.lang.String definition code for java.lang.String  prompt, int messageType, String sample code for java.lang.String definition code for 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 sample code for javax.security.auth.callback.ConfirmationCallback.getDefaultOption() definition code for javax.security.auth.callback.ConfirmationCallback.getDefaultOption() ()
          Get the default option.
 int getMessageType sample code for javax.security.auth.callback.ConfirmationCallback.getMessageType() definition code for javax.security.auth.callback.ConfirmationCallback.getMessageType() ()
          Get the message type.
 String sample code for java.lang.String definition code for java.lang.String [] getOptions sample code for javax.security.auth.callback.ConfirmationCallback.getOptions() definition code for javax.security.auth.callback.ConfirmationCallback.getOptions() ()
          Get the confirmation options.
 int getOptionType sample code for javax.security.auth.callback.ConfirmationCallback.getOptionType() definition code for javax.security.auth.callback.ConfirmationCallback.getOptionType() ()
          Get the option type.
 String sample code for java.lang.String definition code for java.lang.String getPrompt sample code for javax.security.auth.callback.ConfirmationCallback.getPrompt() definition code for javax.security.auth.callback.ConfirmationCallback.getPrompt() ()
          Get the prompt.
 int getSelectedIndex sample code for javax.security.auth.callback.ConfirmationCallback.getSelectedIndex() definition code for javax.security.auth.callback.ConfirmationCallback.getSelectedIndex() ()
          Get the selected confirmation option.
 void setSelectedIndex sample code for javax.security.auth.callback.ConfirmationCallback.setSelectedIndex(int) definition code for javax.security.auth.callback.ConfirmationCallback.setSelectedIndex(int) (int selection)
          Set the selected confirmation option.
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Field Detail

UNSPECIFIED_OPTION sample code for javax.security.auth.callback.ConfirmationCallback.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 sample code for javax.security.auth.callback.ConfirmationCallback.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 sample code for javax.security.auth.callback.ConfirmationCallback.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 sample code for javax.security.auth.callback.ConfirmationCallback.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 sample code for javax.security.auth.callback.ConfirmationCallback.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 sample code for javax.security.auth.callback.ConfirmationCallback.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 sample code for javax.security.auth.callback.ConfirmationCallback.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 sample code for javax.security.auth.callback.ConfirmationCallback.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 sample code for javax.security.auth.callback.ConfirmationCallback.INFORMATION

public static final int INFORMATION
INFORMATION message type.

See Also:
Constant Field Values

WARNING sample code for javax.security.auth.callback.ConfirmationCallback.WARNING

public static final int WARNING
WARNING message type.

See Also:
Constant Field Values

ERROR sample code for javax.security.auth.callback.ConfirmationCallback.ERROR

public static final int ERROR
ERROR message type.

See Also:
Constant Field Values
Constructor Detail

ConfirmationCallback sample code for javax.security.auth.callback.ConfirmationCallback(int, int, int) definition code for javax.security.auth.callback.ConfirmationCallback(int, int, int)

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 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:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for 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 sample code for javax.security.auth.callback.ConfirmationCallback(int, java.lang.String[], int) definition code for javax.security.auth.callback.ConfirmationCallback(int, java.lang.String[], int)

public ConfirmationCallback(int messageType,
                            String sample code for java.lang.String definition code for 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.

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:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for 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 sample code for javax.security.auth.callback.ConfirmationCallback(java.lang.String, int, int, int) definition code for javax.security.auth.callback.ConfirmationCallback(java.lang.String, int, int, int)

public ConfirmationCallback(String sample code for java.lang.String definition code for 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.

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:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for 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 sample code for javax.security.auth.callback.ConfirmationCallback(java.lang.String, int, java.lang.String[], int) definition code for javax.security.auth.callback.ConfirmationCallback(java.lang.String, int, java.lang.String[], int)

public ConfirmationCallback(String sample code for java.lang.String definition code for java.lang.String  prompt,
                            int messageType,
                            String sample code for java.lang.String definition code for 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.

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:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for 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 sample code for javax.security.auth.callback.ConfirmationCallback.getPrompt() definition code for javax.security.auth.callback.ConfirmationCallback.getPrompt()

public String sample code for java.lang.String definition code for java.lang.String  getPrompt()
Get the prompt.

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

getMessageType sample code for javax.security.auth.callback.ConfirmationCallback.getMessageType() definition code for javax.security.auth.callback.ConfirmationCallback.getMessageType()

public int getMessageType()
Get the message type.

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

getOptionType sample code for javax.security.auth.callback.ConfirmationCallback.getOptionType() definition code for javax.security.auth.callback.ConfirmationCallback.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 or OK_CANCEL_OPTION), or UNSPECIFIED_OPTION if this ConfirmationCallback was instantiated with options instead of an optionType.

getOptions sample code for javax.security.auth.callback.ConfirmationCallback.getOptions() definition code for javax.security.auth.callback.ConfirmationCallback.getOptions()

public String sample code for java.lang.String definition code for 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 sample code for javax.security.auth.callback.ConfirmationCallback.getDefaultOption() definition code for javax.security.auth.callback.ConfirmationCallback.getDefaultOption()

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 sample code for javax.security.auth.callback.ConfirmationCallback.setSelectedIndex(int) definition code for javax.security.auth.callback.ConfirmationCallback.setSelectedIndex(int)

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() sample code for javax.security.auth.callback.ConfirmationCallback.getSelectedIndex() definition code for javax.security.auth.callback.ConfirmationCallback.getSelectedIndex()

getSelectedIndex sample code for javax.security.auth.callback.ConfirmationCallback.getSelectedIndex() definition code for javax.security.auth.callback.ConfirmationCallback.getSelectedIndex()

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:
setSelectedIndex(int) sample code for javax.security.auth.callback.ConfirmationCallback.setSelectedIndex(int) definition code for javax.security.auth.callback.ConfirmationCallback.setSelectedIndex(int)