ConfirmationCallback (Java Platform SE 7)

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 などの確認を要求します。

関連項目:
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

- フィールドの詳細
  - 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)

バグまたは機能を送信
詳細な API リファレンスおよび開発者ドキュメントについては、Java SE のドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.

クラス 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