javax.security.auth.callback.ConfirmationCallback — clojure-interop/javax.security 1.0.5

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.

*-cancel clj

Static Constant.

CANCEL option.

If an optionType was specified to this ConfirmationCallback, this option may be specified as a defaultOption or returned as the selected index.

type: int

*-error clj

Static Constant.

ERROR message type.

type: int

*-information clj

Static Constant.

INFORMATION message type.

type: int

*-no clj

Static Constant.

NO option.

If an optionType was specified to this ConfirmationCallback, this option may be specified as a defaultOption or returned as the selected index.

type: int

*-ok clj

Static Constant.

OK option.

If an optionType was specified to this ConfirmationCallback, this option may be specified as a defaultOption or returned as the selected index.

type: int

*-ok-cancel-option clj

Static Constant.

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.

type: int

*-unspecified-option clj

Static Constant.

Unspecified option type.

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

type: int

*-warning clj

Static Constant.

WARNING message type.

type: int

*-yes clj

Static Constant.

YES option.

If an optionType was specified to this ConfirmationCallback, this option may be specified as a defaultOption or returned as the selected index.

type: int

*-yes-no-cancel-option clj

Static Constant.

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.

type: int

*-yes-no-option clj

Static Constant.

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.

type: int

->confirmation-callback clj

(->confirmation-callback message-type option-type default-option)

(->confirmation-callback prompt message-type option-type default-option)

Constructor.

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. - java.lang.String message-type - the message type (INFORMATION, WARNING or ERROR). - int option-type - the option type (YES_NO_OPTION, YES_NO_CANCEL_OPTION or OK_CANCEL_OPTION). - int default-option - the default option from the provided optionType (YES, NO, CANCEL or OK). - int

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.

get-default-option clj

(get-default-option this)

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

get-message-type clj

(get-message-type this)

Get the message type.

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

get-option-type clj

(get-option-type this)

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

get-options clj

(get-options this)

Get the confirmation options.

returns: the list of confirmation options, or null if this ConfirmationCallback was instantiated with an optionType instead of options. - java.lang.String[]

get-prompt clj

(get-prompt this)

Get the prompt.

returns: the prompt, or null if this ConfirmationCallback was instantiated without a prompt. - java.lang.String

get-selected-index clj

(get-selected-index this)

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

set-selected-index clj

(set-selected-index this selection)

Set the selected confirmation option.

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