Module java.base
Package javax.security.auth.callback

Class ConfirmationCallback

java.lang.Object
javax.security.auth.callback.ConfirmationCallback
所有已实现的接口:
Serializable, Callback
public class ConfirmationCallback extends Object implements Callback, Serializable

底层安全服务实例化并将一个ConfirmationCallback传递给CallbackHandler的handle方法，以请求YES/NO、OK/CANCEL、YES/NO/CANCEL或其他类似的确认。

自从:
1.4
参见:

  • Field Details

    • UNSPECIFIED_OPTION

      public static final int UNSPECIFIED_OPTION
      未指定的选项类型。

      如果此ConfirmationCallback是使用options而不是optionType实例化的，则getOptionType方法返回此值。

      参见:

    • YES_NO_OPTION

      public static final int YES_NO_OPTION
      YES/NO确认选项。

      如果底层安全服务需要一个可以用YES或NO回答的确认，则将此选项指定为ConfirmationCallback构造函数的optionType。

      参见:

    • YES_NO_CANCEL_OPTION

      public static final int YES_NO_CANCEL_OPTION
      YES/NO/CANCEL确认选项。

      如果底层安全服务需要一个可以用YES、NO或CANCEL回答的确认，则将此选项指定为ConfirmationCallback构造函数的optionType。

      参见:

    • OK_CANCEL_OPTION

      public static final int OK_CANCEL_OPTION
      OK/CANCEL确认选项。

      如果底层安全服务需要一个可以用OK或CANCEL回答的确认，则将此选项指定为ConfirmationCallback构造函数的optionType。

      参见:

    • YES

      public static final int YES
      YES选项。

      如果此ConfirmationCallback指定了optionType，则此选项可以作为defaultOption指定，或者作为所选索引返回。

      参见:

    • NO

      public static final int NO
      NO选项。

      如果此ConfirmationCallback指定了optionType，则此选项可以作为defaultOption指定，或者作为所选索引返回。

      参见:

    • CANCEL

      public static final int CANCEL
      取消选项。

      如果此ConfirmationCallback指定了optionType，则此选项可以作为defaultOption指定，或者作为所选索引返回。

      参见:

    • OK

      public static final int OK
      OK选项。

      如果此ConfirmationCallback指定了optionType，则此选项可以作为defaultOption指定，或者作为所选索引返回。

      参见:

    • INFORMATION

      public static final int INFORMATION
      信息消息类型。
      参见:

    • WARNING

      public static final int WARNING
      警告消息类型。
      参见:

    • ERROR

      public static final int ERROR
      错误消息类型。
      参见:

  • Constructor Details

    • ConfirmationCallback

      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 - 如果消息类型不是INFORMATION、WARNING或ERROR，如果选项类型不是YES_NO_OPTION、YES_NO_CANCEL_OPTION或OK_CANCEL_OPTION，或者如果defaultOption不对应于optionType中的一个选项。

    • ConfirmationCallback

      public ConfirmationCallback(int messageType, String[] options, int defaultOption)
      使用消息类型、选项列表和默认选项构造一个ConfirmationCallback。

      如果底层安全服务需要与提供的可用预设确认不同的确认（例如，CONTINUE/ABORT或STOP/GO），则使用此构造函数。确认选项在options数组中列出，并由CallbackHandler实现以与预设选项显示方式一致的方式显示。

      参数:
      messageType - 消息类型（INFORMATION、WARNING或ERROR）。
      options - 确认选项列表。为防止后续修改，数组将被克隆。
      defaultOption - 默认选项，表示为options数组中的索引。
      抛出:
      IllegalArgumentException - 如果消息类型不是INFORMATION、WARNING或ERROR，如果options为null，如果options的长度为0，如果options中的任何元素为null，如果options中的任何元素的长度为0，或者如果defaultOption不在options数组的范围内。

    • ConfirmationCallback

      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，如果消息类型不是INFORMATION、WARNING或ERROR，如果选项类型不是YES_NO_OPTION、YES_NO_CANCEL_OPTION或OK_CANCEL_OPTION，或者如果defaultOption不对应于optionType中的一个选项。

    • ConfirmationCallback

      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，如果消息类型不是INFORMATION、WARNING或ERROR，如果options为null，如果options长度为0，如果options中的任何元素为null，如果options中的任何元素长度为0，或者如果defaultOption不在options数组的范围内。

  • Method Details

    • getPrompt

      public String getPrompt()
      获取提示。
      返回:
      提示，如果此ConfirmationCallback实例化时没有prompt则返回null。

    • getMessageType

      public int getMessageType()
      获取消息类型。
      返回:
      消息类型（INFORMATION、WARNING或ERROR）。

    • getOptionType

      public int getOptionType()
      获取选项类型。

      如果此方法返回UNSPECIFIED_OPTION，则此ConfirmationCallback是使用options而不是optionType实例化的。在这种情况下，调用getOptions方法以确定要显示哪些确认选项。

      返回:
      选项类型（YES_NO_OPTION、YES_NO_CANCEL_OPTION或OK_CANCEL_OPTION），如果此ConfirmationCallback是使用options而不是optionType实例化的，则返回UNSPECIFIED_OPTION。

    • getOptions

      public String[] getOptions()
      获取确认选项。
      返回:
      确认选项列表的副本，如果此ConfirmationCallback是使用optionType而不是options实例化的则返回null。

    • getDefaultOption

      public int getDefaultOption()
      获取默认选项。
      返回:
      默认选项，如果此ConfirmationCallback的构造函数指定了optionType，则表示为YES、NO、OK或CANCEL。否则，此方法将返回构造函数指定的ConfirmationCallback的options数组中的默认选项索引。

    • setSelectedIndex

      public void setSelectedIndex(int selection)
      设置所选的确认选项。
      参数:
      selection - 如果此ConfirmationCallback的构造函数指定了optionType，则表示为YES、NO、OK或CANCEL。否则，选择表示构造函数指定的ConfirmationCallback的options数组中的索引。
      参见:

    • getSelectedIndex

      public int getSelectedIndex()
      获取所选的确认选项。
      返回:
      所选的确认选项，如果此ConfirmationCallback的构造函数指定了optionType，则表示为YES、NO、OK或CANCEL。否则，此方法将返回构造函数指定的ConfirmationCallback的options数组中的所选确认选项索引。
      参见: