java.lang.Object javax.security.auth.callback.ConfirmationCallback
public class ConfirmationCallback
底层安全服务实例化 ConfirmationCallback
,并将其传递到 CallbackHandler
的 handle
方法,以请求 YES/NO、OK/CANCEL、YES/NO/CANCEL 或其他类似的确认信息。
CallbackHandler
,
序列化表格
字段摘要 | |
---|---|
static int |
CANCEL CANCEL 选项。 |
static int |
ERROR ERROR 消息类型。 |
static int |
INFORMATION INFORMATION 消息类型。 |
static int |
NO NO 选项。 |
static int |
OK OK 选项。 |
static int |
OK_CANCEL_OPTION OK/CANCEL 确认选项。 |
static int |
UNSPECIFIED_OPTION 未指定的选项类型。 |
static int |
WARNING WARNING 消息类型。 |
static int |
YES YES 选项。 |
static int |
YES_NO_CANCEL_OPTION YES/NO/CANCEL 确认选项。 |
static int |
YES_NO_OPTION YES/NO 确认选项。 |
构造方法摘要 | |
---|---|
ConfirmationCallback(int messageType, int optionType, int defaultOption) 构造一个带有消息类型、选项类型和默认选项的 ConfirmationCallback 。 |
|
ConfirmationCallback(int messageType, String[] options, int defaultOption) 构造一个带有消息类型、选项列表和默认选项的 ConfirmationCallback 。 |
|
ConfirmationCallback(String prompt, int messageType, int optionType, int defaultOption) 构造一个带有提示、消息类型、选项类型和默认选项的 ConfirmationCallback 。 |
|
ConfirmationCallback(String prompt, int messageType, String[] options, int defaultOption) 构造一个带有提示、消息类型、选项列表和默认选项的 ConfirmationCallback 。 |
方法摘要 | |
---|---|
int |
getDefaultOption() 获取默认选项。 |
int |
getMessageType() 获取消息类型。 |
String[] |
getOptions() 获取确认选项。 |
int |
getOptionType() 获取选项类型。 |
String |
getPrompt() 获取提示。 |
int |
getSelectedIndex() 获取选中的确认选项。 |
void |
setSelectedIndex(int selection) 设置选中的确认选项。 |
从类 java.lang.Object 继承的方法 |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
字段详细信息 |
---|
public static final int UNSPECIFIED_OPTION
如果此 ConfirmationCallback
是使用 options
而不是 optionType
实例化的,则 getOptionType
方法返回此值。
public static final int YES_NO_OPTION
如果 ConfirmationCallback
构造方法需要一个以 YES
或 NO
作答的确认信息,则底层安全服务将此值指定为 ConfirmationCallback
构造方法的 optionType
。
public static final int YES_NO_CANCEL_OPTION
如果 ConfirmationCallback
构造方法需要一个以 YES
、NO
或 CANCEL
作答的确认信息,则底层安全服务将此值指定为 ConfirmationCallback
构造方法的 optionType
。
public static final int OK_CANCEL_OPTION
如果 ConfirmationCallback
构造方法需要一个以 OK
或 CANCEL
作答的确认信息,则底层安全服务将此值指定为 ConfirmationCallback
构造方法的 optionType
。
public static final int YES
如果指定了此 ConfirmationCallback
的 optionType
,则可以将此选项指定为 defaultOption
或作为选择的索引返回。
public static final int NO
如果指定了此 ConfirmationCallback
的 optionType
,则可以将此选项指定为 defaultOption
或作为选择的索引返回。
public static final int CANCEL
如果指定了此 ConfirmationCallback
的 optionType
,则可以将此选项指定为 defaultOption
或作为选择的索引返回。
public static final int OK
如果指定了此 ConfirmationCallback
的 optionType
,则可以将此选项指定为 defaultOption
或作为选择的索引返回。
public static final int INFORMATION
public static final int WARNING
public static final int ERROR
构造方法详细信息 |
---|
public ConfirmationCallback(int messageType, int optionType, int defaultOption)
ConfirmationCallback
。
如果底层安全服务需要 YES/NO、 YES/NO/CANCEL 或 OK/CANCEL 确认信息,则它们使用此构造方法。
messageType
- 消息类型(
INFORMATION
、
WARNING
或
ERROR
)。
optionType
- 选项类型(
YES_NO_OPTION
、
YES_NO_CANCEL_OPTION
或
OK_CANCEL_OPTION
)。
defaultOption
- 从提供的 optionType(
YES
、
NO
、
CANCEL
或
OK
)得出的默认选项。
IllegalArgumentException
- 如果 messageType 不是
INFORMATION
、
WARNING
或
ERROR
,如果 optionType 不是
YES_NO_OPTION
、
YES_NO_CANCEL_OPTION
或
OK_CANCEL_OPTION
,或者
defaultOption
不与
optionType
中的某个选项对应。
public ConfirmationCallback(int messageType, String[] options, int defaultOption)
ConfirmationCallback
。
如果底层安全服务需要的确认信息不同于可供使用的、已提供的预置确认信息(例如,CONTINUE/ABORT 或 STOP/GO),则它们使用此构造方法。确认选项在 options
数组中列出,由 CallbackHandler
实现通过与预置选项一致的方式显示。
messageType
- 消息类型(
INFORMATION
、
WARNING
或
ERROR
)。
options
- 确认选项列表。
defaultOption
- 默认选项,表示为
options
数组中的索引。
IllegalArgumentException
- 如果 messageType 不是
INFORMATION
、
WARNING
或
ERROR
,如果
options
为 null,如果
options
的长度为 0,如果
options
中的任何一个元素为 null,如果
options
中的任何一个元素的长度为 0,或者
defaultOption
不在
options
的数组边界内。
public ConfirmationCallback(String prompt, int messageType, int optionType, int defaultOption)
ConfirmationCallback
。
如果底层安全服务需要 YES/NO、 YES/NO/CANCEL 或 OK/CANCEL 确认信息,则它们使用此构造方法。
prompt
- 用于描述选项列表的提示。
messageType
- 消息类型(
INFORMATION
、
WARNING
或
ERROR
)。
optionType
- 选项类型(
YES_NO_OPTION
、
YES_NO_CANCEL_OPTION
或
OK_CANCEL_OPTION
)。
defaultOption
- 从提供的 optionType(
YES
、
NO
、
CANCEL
或
OK
)得出的默认选项。
IllegalArgumentException
- 如果
prompt
为 null,如果
prompt
的长度为 0,如果 messageType 不是
INFORMATION
、
WARNING
或
ERROR
,如果 optionType 不是
YES_NO_OPTION
、
YES_NO_CANCEL_OPTION
或
OK_CANCEL_OPTION
,或者
defaultOption
不对应于
optionType
中的某个选项。
public ConfirmationCallback(String prompt, int messageType, String[] options, int defaultOption)
ConfirmationCallback
。
如果底层安全服务需要的确认信息不同于可供使用的、已提供的预置确认信息(例如,CONTINUE/ABORT 或 STOP/GO),则它们使用此构造方法。确认选项在 options
数组中列出,由 CallbackHandler
实现通过与预置选项一致的方式显示。
prompt
- 用于描述选项列表的提示。
messageType
- 消息类型(
INFORMATION
、
WARNING
或
ERROR
)。
options
- 确认选项列表。
defaultOption
- 默认选项,表示为
options
数组中的索引。
IllegalArgumentException
- 如果
prompt
为 null,如果
prompt
的长度为 0,如果 messageType 不是
INFORMATION
、
WARNING
或
ERROR
,如果
options
为 null,如果
options
的长度为 0,如果
options
中的任何一个元素为 null,如果
options
中的任何一个元素长度为 0,或者
defaultOption
不是位于
options
的数组边界内。
方法详细信息 |
---|
public String getPrompt()
ConfirmationCallback
实例化为不带
prompt
,则返回 null。
public int getMessageType()
INFORMATION
、
WARNING
或
ERROR
)。
public int getOptionType()
如果此方法返回 UNSPECIFIED_OPTION
,那么此 ConfirmationCallback
是使用 options
而不是 optionType
实例化的。在这种情况下,调用 getOptions
方法,以确定显示何种确认选项。
YES_NO_OPTION
、
YES_NO_CANCEL_OPTION
或
OK_CANCEL_OPTION
),如果此
ConfirmationCallback
是使用
options
而不是
optionType
实例化的,则返回
UNSPECIFIED_OPTION
。
public String[] getOptions()
ConfirmationCallback
是使用
optionType
而不是
options
实例化的,则返回 null。
public int getDefaultOption()
ConfirmationCallback
的构造方法指定了
optionType
,则表示为
YES
、
NO
、
OK
或
CANCEL
。否则,此方法返回默认选项,作为为此
ConfirmationCallback
的构造方法指定的
options
数组中的索引。
public void setSelectedIndex(int selection)
selection
- 如果为此
ConfirmationCallback
的构造方法指定了一个
optionType
,则该 selection 表示为
YES
、
NO
、
OK
或
CANCEL
。否则,该 selection 表示为为此
ConfirmationCallback
的构造方法指定的
options
数组中的索引。
getSelectedIndex()
public int getSelectedIndex()
ConfirmationCallback
的构造方法指定了一个
optionType
,则返回选中的确认选项,表示为
YES
、
NO
、
OK
或
CANCEL
。否则,此方法返回选中的确认选项,作为为此
ConfirmationCallback
的构造方法指定的
options
数组中的索引。
setSelectedIndex(int)