OpenJDK 27 · javax.security.auth.callback.ConfirmationCallback

Modifier and Type	Field and Description
public static final int	CANCEL CANCEL option.
private final int	defaultOption
public static final int	ERROR ERROR message type.
public static final int	INFORMATION INFORMATION message type.
private final int	messageType
public static final int	NO NO option.
public static final int	OK OK option.
public static final int	OK_CANCEL_OPTION OK/CANCEL confirmation option.
private String[]	options
private final int	optionType
private final String	prompt
private int	selection
private static final long	serialVersionUID
public static final int	UNSPECIFIED_OPTION Unspecified option type.
public static final int	WARNING WARNING message type.
public static final int	YES YES option.
public static final int	YES_NO_CANCEL_OPTION YES/NO/CANCEL confirmation option.
public static final int	YES_NO_OPTION YES/NO confirmation option.

Constructor Summary

Access	Constructor and Description
public	ConfirmationCallback(int the message type (`INFORMATION`, `WARNING` or `ERROR`). messageType, int the option type (`YES_NO_OPTION`, `YES_NO_CANCEL_OPTION` or `OK_CANCEL_OPTION`). optionType, int the default option from the provided optionType (`YES`, `NO`, `CANCEL` or `OK`). defaultOption) Construct a `ConfirmationCallback` with a message type, an option type and a default option.
public	ConfirmationCallback(int the message type (`INFORMATION`, `WARNING` or `ERROR`). messageType, String[] the list of confirmation options. The array is cloned to protect against subsequent modification. options, int the default option, represented as an index into the `options` array. defaultOption) Construct a `ConfirmationCallback` with a message type, a list of options and a default option.
public	ConfirmationCallback(String the prompt used to describe the list of options. prompt, int the message type (`INFORMATION`, `WARNING` or `ERROR`). messageType, int the option type (`YES_NO_OPTION`, `YES_NO_CANCEL_OPTION` or `OK_CANCEL_OPTION`). optionType, int the default option from the provided optionType (`YES`, `NO`, `CANCEL` or `OK`). defaultOption) Construct a `ConfirmationCallback` with a prompt, message type, an option type and a default option.
public	ConfirmationCallback(String the prompt used to describe the list of options. prompt, int the message type (`INFORMATION`, `WARNING` or `ERROR`). messageType, String[] the list of confirmation options. The array is cloned to protect against subsequent modification. options, int the default option, represented as an index into the `options` array. 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
private static String	doSanityCheck(int msgType, int optionType, boolean isUnspecifiedOption, String[] options, int defOption, String prompt, boolean checkPrompt)
public int	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`. getDefaultOption() Get the default option.
public int	Returns: the message type (`INFORMATION`, `WARNING` or `ERROR`). getMessageType() Get the message type.
public String[]	Returns: a copy of the list of confirmation options, or null if this `ConfirmationCallback` was instantiated with an `optionType` instead of `options`. getOptions() Get the confirmation options.
public int	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`. getOptionType() Get the option type.
public String	Returns: the prompt, or null if this `ConfirmationCallback` was instantiated without a `prompt`. getPrompt() Get the prompt.
public int	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`. getSelectedIndex() Get the selected confirmation option.
private void	readObject(ObjectInputStream the `ObjectInputStream` from which data is read stream) Restores the state of this object from the stream.
public void	setSelectedIndex(int 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`. selection) Set the selected confirmation option.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

CANCEL back to summary

CANCEL	back to summary
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 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.

defaultOption	back to summary
private final int defaultOption Since 1.4

ERROR	back to summary
public static final int ERROR ERROR message type.

INFORMATION	back to summary
public static final int INFORMATION INFORMATION message type.

messageType	back to summary
private final int messageType Since 1.4

NO back to summary

NO	back to summary
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 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.

OK back to summary

OK	back to summary
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 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.

OK_CANCEL_OPTION back to summary

OK_CANCEL_OPTION	back to summary
public static final int OK_CANCEL_OPTION OK/CANCEL 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 OK_CANCEL_OPTION

OK/CANCEL 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.

options	back to summary
private String[] options Since 1.4

optionType	back to summary
private final int optionType Since 1.4

prompt	back to summary
private final String prompt Since 1.4

selection	back to summary
private int selection Since 1.4

serialVersionUID	back to summary
private static final long serialVersionUID Annotations @Serial

UNSPECIFIED_OPTION back to summary

UNSPECIFIED_OPTION	back to summary
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 UNSPECIFIED_OPTION

Unspecified option type.

The getOptionType method returns this value if this ConfirmationCallback was instantiated with options instead of an optionType.

WARNING	back to summary
public static final int WARNING WARNING message type.

YES back to summary

YES	back to summary
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 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.

YES_NO_CANCEL_OPTION back to summary

YES_NO_CANCEL_OPTION	back to summary
public static final int YES_NO_CANCEL_OPTION YES/NO/CANCEL 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 YES_NO_CANCEL_OPTION

YES/NO/CANCEL 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.

YES_NO_OPTION back to summary

YES_NO_OPTION	back to summary
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_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.

Constructor Detail

ConfirmationCallback back to summary

ConfirmationCallback	back to summary
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:int the message type (`INFORMATION`, `WARNING` or `ERROR`). optionType:int the option type (`YES_NO_OPTION`, `YES_NO_CANCEL_OPTION` or `OK_CANCEL_OPTION`). defaultOption:int the default option from the provided optionType (`YES`, `NO`, `CANCEL` or `OK`). Exceptions 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, 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:int: the message type (INFORMATION, WARNING or ERROR).
optionType:int: the option type (YES_NO_OPTION, YES_NO_CANCEL_OPTION or OK_CANCEL_OPTION).
defaultOption:int: the default option from the provided optionType (YES, NO, CANCEL or OK).

Exceptions

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 back to summary

ConfirmationCallback	back to summary
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:int the message type (`INFORMATION`, `WARNING` or `ERROR`). options:String[] the list of confirmation options. The array is cloned to protect against subsequent modification. defaultOption:int the default option, represented as an index into the `options` array. Exceptions 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(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:int: the message type (INFORMATION, WARNING or ERROR).
options:String[]: the list of confirmation options. The array is cloned to protect against subsequent modification.
defaultOption:int: the default option, represented as an index into the options array.

Exceptions

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 back to summary

ConfirmationCallback	back to summary
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:String the prompt used to describe the list of options. messageType:int the message type (`INFORMATION`, `WARNING` or `ERROR`). optionType:int the option type (`YES_NO_OPTION`, `YES_NO_CANCEL_OPTION` or `OK_CANCEL_OPTION`). defaultOption:int the default option from the provided optionType (`YES`, `NO`, `CANCEL` or `OK`). Exceptions 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, 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:String: the prompt used to describe the list of options.
messageType:int: the message type (INFORMATION, WARNING or ERROR).
optionType:int: the option type (YES_NO_OPTION, YES_NO_CANCEL_OPTION or OK_CANCEL_OPTION).
defaultOption:int: the default option from the provided optionType (YES, NO, CANCEL or OK).

Exceptions

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 back to summary

ConfirmationCallback	back to summary
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:String the prompt used to describe the list of options. messageType:int the message type (`INFORMATION`, `WARNING` or `ERROR`). options:String[] the list of confirmation options. The array is cloned to protect against subsequent modification. defaultOption:int the default option, represented as an index into the `options` array. Exceptions 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 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.

Parameters

prompt:String: the prompt used to describe the list of options.
messageType:int: the message type (INFORMATION, WARNING or ERROR).
options:String[]: the list of confirmation options. The array is cloned to protect against subsequent modification.
defaultOption:int: the default option, represented as an index into the options array.

Exceptions

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

doSanityCheck	back to summary
private static String doSanityCheck(int msgType, int optionType, boolean isUnspecifiedOption, String[] options, int defOption, String prompt, boolean checkPrompt)

getDefaultOption back to summary

getDefaultOption	back to summary
public int getDefaultOption() Get the default option. Returns:int 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`.

public int getDefaultOption()

Get the default option.

Returns:int: 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.

getMessageType back to summary

getMessageType	back to summary
public int getMessageType() Get the message type. Returns:int the message type (`INFORMATION`, `WARNING` or `ERROR`).

public int getMessageType()

Get the message type.

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

getOptions back to summary

getOptions	back to summary
public String[] getOptions() Get the confirmation options. Returns:String[] a copy of the list of confirmation options, or null if this `ConfirmationCallback` was instantiated with an `optionType` instead of `options`.

public String[] getOptions()

Get the confirmation options.

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

getOptionType back to summary

getOptionType	back to summary
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:int 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`.

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

getPrompt back to summary

getPrompt	back to summary
public String getPrompt() Get the prompt. Returns:String the prompt, or null if this `ConfirmationCallback` was instantiated without a `prompt`.

public String getPrompt()

Get the prompt.

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

getSelectedIndex back to summary

getSelectedIndex	back to summary
public int getSelectedIndex() Get the selected confirmation option. Returns:int 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`

public int getSelectedIndex()

Get the selected confirmation option.

Returns:int: 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

readObject back to summary

readObject	back to summary
private void readObject(ObjectInputStream stream) throws IOException, ClassNotFoundException Restores the state of this object from the stream. Parameters stream:ObjectInputStream the `ObjectInputStream` from which data is read Annotations @Serial Exceptions IOException: if an I/O error occurs ClassNotFoundException: if a serialized class cannot be loaded

private void readObject(ObjectInputStream stream) throws IOException, ClassNotFoundException

Restores the state of this object from the stream.

Parameters

stream:ObjectInputStream: the ObjectInputStream from which data is read

Annotations

@Serial

Exceptions

IOException:: if an I/O error occurs
ClassNotFoundException:: if a serialized class cannot be loaded

setSelectedIndex back to summary

setSelectedIndex	back to summary
public void setSelectedIndex(int selection) Set the selected confirmation option. Parameters selection:int 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`

public void setSelectedIndex(int selection)

Set the selected confirmation option.

Parameters

selection:int: 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

public Class ConfirmationCallback

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail