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

関連項目:

フィールドのサマリー

フィールド

修飾子と型

フィールド

説明

static final int

CANCEL

CANCELオプションです。

static final int

ERROR

ERRORメッセージ・タイプです。

static final int

INFORMATION

INFORMATIONメッセージ・タイプです。

static final int

NO

NOオプションです。

static final int

OK

OKオプションです。

static final int

OK_CANCEL_OPTION

OK/CANCELの確認オプションです。

static final int

UNSPECIFIED_OPTION

指定のないオプション・タイプです。

static final int

WARNING

WARNINGメッセージ・タイプです。

static final int

YES

YESオプションです。

static final int

YES_NO_CANCEL_OPTION

YES/NO/CANCEL確認オプションです。

static final 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

フィールド詳細
- UNSPECIFIED_OPTION
  public static final int UNSPECIFIED_OPTION
  
  指定のないオプション・タイプです。
  このConfirmationCallbackが、optionTypeではなくoptionsでインスタンス化された場合、getOptionTypeメソッドはこの値を返します。
  
  関連項目:
  
  定数フィールド値
- YES_NO_OPTION
  public static final int YES_NO_OPTION
  
  YES/NOの確認オプションです。
  ベースとなるセキュリティ・サービスでは、YESまたはNOで回答できる確認を要求するときに、この確認オプションをoptionTypeとしてConfirmationCallbackコンストラクタに指定します。
  
  関連項目:
  
  定数フィールド値
- YES_NO_CANCEL_OPTION
  public static final int YES_NO_CANCEL_OPTION
  
  YES/NO/CANCEL確認オプションです。
  ベースとなるセキュリティ・サービスでは、YES、NO、またはCANCELで回答できる確認が必要な場合に、この確認オプションをoptionTypeとしてConfirmationCallbackコンストラクタに指定します。
  
  関連項目:
  
  定数フィールド値
- OK_CANCEL_OPTION
  public static final int OK_CANCEL_OPTION
  
  OK/CANCELの確認オプションです。
  ベースとなるセキュリティ・サービスでは、OKまたはCANCELで回答できる確認を要求するときに、この確認オプションをoptionTypeとしてConfirmationCallbackコンストラクタに指定します。
  
  関連項目:
  
  定数フィールド値
- 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
  
  CANCELオプションです。
  このConfirmationCallbackでoptionTypeが指定された場合、このオプションはdefaultOptionとして指定されるか、選択したインデックスとして返されます。
  
  関連項目:
  
  定数フィールド値
- OK
  public static final int OK
  
  OKオプションです。
  このConfirmationCallbackでoptionTypeが指定された場合、このオプションはdefaultOptionとして指定されるか、選択したインデックスとして返されます。
  
  関連項目:
  
  定数フィールド値
- INFORMATION
  public static final int INFORMATION
  
  INFORMATIONメッセージ・タイプです。
  
  関連項目:
  
  定数フィールド値
- WARNING
  public static final int WARNING
  
  WARNINGメッセージ・タイプです。
  
  関連項目:
  
  定数フィールド値
- ERROR
  public static final int ERROR
  
  ERRORメッセージ・タイプです。
  
  関連項目:
  
  定数フィールド値
コンストラクタの詳細
- 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 - messageTypeがINFORMATION、WARNING、ERRORのいずれでもない場合、optionTypeが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 - messageTypeが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の場合、messageTypeがINFORMATION、WARNING、ERRORのいずれでもない場合、optionTypeが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の場合、messageTypeがINFORMATION、WARNING、ERRORのいずれでもない場合、optionsがnullの場合、optionsの長さが0の場合、optionsのいずれかの要素がnullの場合、optionsのいずれかの要素の長さが0の場合、またはdefaultOptionがoptionsの配列境界内にない場合。
メソッドの詳細
- getPrompt
  
  public String getPrompt()
  
  プロンプトを取得します。
  
  戻り値:
  
  プロンプト。このConfirmationCallbackがpromptなしでインスタンス化された場合はnull。
- getMessageType
  
  public int getMessageType()
  
  メッセージ・タイプを取得します。
  
  戻り値:
  
  メッセージ・タイプ(INFORMATION、WARNING、またはERROR)。
- getOptionType
  
  public int getOptionType()
  
  オプション・タイプを取得します。
  このConfirmationCallbackが、optionTypeではなくoptionsでインスタンス化された場合、このメソッドはUNSPECIFIED_OPTIONを返します。その場合は、getOptionsを呼び出して、表示する確認オプションを決定してください。
  
  戻り値:
  
  オプション・タイプ(YES_NO_OPTION、YES_NO_CANCEL_OPTION、OK_CANCEL_OPTION)。このConfirmationCallbackがoptionTypeではなくoptionsでインスタンス化された場合はUNSPECIFIED_OPTION。
- getOptions
  
  public String[] getOptions()
  
  確認オプションを取得します。
  
  戻り値:
  
  確認オプションのリストのコピー。このConfirmationCallbackがoptionsではなくoptionTypeでインスタンス化された場合は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()
- getSelectedIndex
  public int getSelectedIndex()
  
  選択された確認オプションを取得します。
  
  戻り値:
  
  このConfirmationCallbackのコンストラクタにoptionTypeを指定した場合は、YES、NO、OK、またはCANCELとして表される選択された確認オプション。それ以外の場合、このメソッドは、このConfirmationCallbackのコンストラクタに指定されたoptions配列のインデックスとして、選択された確認オプションを返す。
  
  関連項目:
  
  setSelectedIndex(int)

クラスConfirmationCallback

フィールドのサマリー

コンストラクタのサマリー

メソッドのサマリー

クラスjava.lang.Objectで宣言されたメソッド

フィールド詳細

UNSPECIFIED_OPTION

YES_NO_OPTION

YES_NO_CANCEL_OPTION

OK_CANCEL_OPTION

YES

NO

CANCEL

OK

INFORMATION

WARNING

ERROR

コンストラクタの詳細

ConfirmationCallback

ConfirmationCallback

ConfirmationCallback

ConfirmationCallback

メソッドの詳細

getPrompt

getMessageType

getOptionType

getOptions

getDefaultOption

setSelectedIndex

getSelectedIndex