JavaTM 2 Platform
Standard Ed. 5.0

javax.security.auth.callback
クラス ConfirmationCallback

java.lang.Object
  上位を拡張 javax.security.auth.callback.ConfirmationCallback
すべての実装されたインタフェース:
Serializable, Callback

public class ConfirmationCallback
extends Object
implements Callback, Serializable

基本となるセキュリティサービスでは、ConfirmationCallback をインスタンス化して CallbackHandlerhandle メソッドに渡し、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
指定のないオプションタイプです。

getOptionType メソッドがこの値を返すのは、この ConfirmationCallbackoptionType ではなく options でインスタンス化された場合です。

関連項目:
定数フィールド値

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 の確認オプションです。

基本セキュリティサービスでは、YESNO、または 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 オプションです。

この ConfirmationCallbackoptionType が指定された場合、このオプションは defaultOption として指定されるか、選択したインデックスとして返されます。

関連項目:
定数フィールド値

NO

public static final int NO
NO オプションです。

この ConfirmationCallbackoptionType が指定された場合、このオプションは defaultOption として指定されるか、選択したインデックスとして返されます。

関連項目:
定数フィールド値

CANCEL

public static final int CANCEL
CANCEL オプションです。

この ConfirmationCallbackoptionType が指定された場合、このオプションは defaultOption として指定されるか、選択したインデックスとして返されます。

関連項目:
定数フィールド値

OK

public static final int OK
OK オプションです。

この ConfirmationCallbackoptionType が指定された場合、このオプションは 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 - メッセージタイプ (INFORMATIONWARNING、または ERROR)

optionType - オプションタイプ (YES_NO_OPTIONYES_NO_CANCEL_OPTION、または OK_CANCEL_OPTION)

defaultOption - 指定した optionType のデフォルトオプション (YESNOCANCEL、または OK)
例外:
IllegalArgumentException - messageType が INFORMATIONWARNINGERROR のどれでもない場合、optionType が YES_NO_OPTIONYES_NO_CANCEL_OPTIONOK_CANCEL_OPTION のどれでもない場合、あるいは defaultOptionoptionType 内のオプションのどれにも対応しない場合

ConfirmationCallback

public ConfirmationCallback(int messageType,
                            String[] options,
                            int defaultOption)
ConfirmationCallback をメッセージタイプ、オプションのリスト、およびデフォルトのオプションを使用して構築します。

基本のセキュリティサービスでは、あらかじめ設定されている利用可能な確認方法とは異なる確認を要求する場合 (たとえば CONTINUE/ABORT や STOP/GO)、このコンストラクタを使用します。確認のオプションは、options 配列にリストされ、あらかじめ登録されているオプションと同様の形式で CallbackHandler 実装によって表示されます。

パラメータ:
messageType - メッセージタイプ (INFORMATIONWARNING、または ERROR)

options - 確認オプションのリスト

defaultOption - options 配列のインデックスとして表されるデフォルトオプション
例外:
IllegalArgumentException - messageType が INFORMATIONWARNINGERROR のどれでもない場合、options が null の場合、options の長さが 0 の場合、options の要素に null がある場合、options の要素に長さ 0 のものがある場合、あるいは defaultOptionoptions の配列範囲内にない場合

ConfirmationCallback

public ConfirmationCallback(String prompt,
                            int messageType,
                            int optionType,
                            int defaultOption)
ConfirmationCallback をプロンプト、メッセージタイプ、オプションタイプ、およびデフォルトのオプションを使用して構築します。

基本セキュリティサービスでは、YES/NO、YES/NO/CANCEL、OK/CANCEL の各確認方法のどれかを要求する場合に、このコンストラクタを使用します。

パラメータ:
prompt - オプションのリストを記述するためのプロンプト

messageType - メッセージタイプ (INFORMATIONWARNING、または ERROR)

optionType - オプションタイプ (YES_NO_OPTIONYES_NO_CANCEL_OPTION、または OK_CANCEL_OPTION)

defaultOption - 指定した optionType のデフォルトオプション (YESNOCANCEL、または OK)
例外:
IllegalArgumentException - prompt が null の場合、prompt の長さが 0 の場合、messageType が INFORMATIONWARNINGERROR のどれでもない場合、optionType が YES_NO_OPTIONYES_NO_CANCEL_OPTIONOK_CANCEL_OPTION のどれでもない場合、あるいは defaultOptionoptionType 内のオプションのどれにも対応しない場合

ConfirmationCallback

public ConfirmationCallback(String prompt,
                            int messageType,
                            String[] options,
                            int defaultOption)
ConfirmationCallback をプロンプト、メッセージタイプ、オプションのリスト、およびデフォルトのオプションを使用して構築します。

基本のセキュリティサービスでは、あらかじめ設定されている利用可能な確認方法とは異なる確認を要求する場合 (たとえば CONTINUE/ABORT や STOP/GO)、このコンストラクタを使用します。確認のオプションは、options 配列にリストされ、あらかじめ登録されているオプションと同様の形式で CallbackHandler 実装によって表示されます。

パラメータ:
prompt - オプションのリストを記述するためのプロンプト

messageType - メッセージタイプ (INFORMATIONWARNING、または ERROR)

options - 確認オプションのリスト

defaultOption - options 配列のインデックスとして表されるデフォルトオプション
例外:
IllegalArgumentException - prompt が null の場合、prompt の長さが 0 の場合、messageType が INFORMATIONWARNINGERROR のどれでもない場合、options が null の場合、options の長さが 0 の場合、options の要素に null がある場合、options の要素のどれかが長さ 0 の場合、あるいは defaultOptionoptions の配列範囲内にない場合
メソッドの詳細

getPrompt

public String getPrompt()
プロンプトを取得します。

戻り値:
プロンプト。この ConfirmationCallbackprompt なしでインスタンス化された場合は null

getMessageType

public int getMessageType()
メッセージタイプを取得します。

戻り値:
メッセージタイプ (INFORMATIONWARNING、または ERROR)

getOptionType

public int getOptionType()
オプションタイプを取得します。

このメソッドが UNSPECIFIED_OPTION を返す場合、この ConfirmationCallbackoptionType ではなく options でインスタンス化されています。このときは、getOptions を呼び出し、表示される確認オプションを確認してください。

戻り値:
オプションタイプ (YES_NO_OPTIONYES_NO_CANCEL_OPTION、または OK_CANCEL_OPTION)。この ConfirmationCallbackoptionType ではなく options でインスタンス化されている場合は UNSPECIFIED_OPTION

getOptions

public String[] getOptions()
確認オプションを取得します。

戻り値:
確認オプションのリスト。この ConfirmationCallbackoptions ではなく optionType でインスタンス化された場合は null

getDefaultOption

public int getDefaultOption()
デフォルトオプションを取得します。

戻り値:
optionType がこの ConfirmationCallback のコンストラクタとして指定されている場合は、YESNOOK、あるいは CANCEL を表すデフォルトオプション。そうでない場合は、この ConfirmationCallback のコンストラクタとして指定された options 配列のインデックスとして、デフォルトオプションを返す

setSelectedIndex

public void setSelectedIndex(int selection)
選択された確認オプションを設定します。

パラメータ:
selection - optionType がこの ConfirmationCallback のコンストラクタとして指定されている場合は、YESNOOK、あるいは CANCEL を表す選択内容。そうでない場合は、この ConfirmationCallback のコンストラクタとして指定された options 配列のインデックスを表す選択内容
関連項目:
getSelectedIndex()

getSelectedIndex

public int getSelectedIndex()
選択された確認オプションを取得します。

戻り値:
optionType がこの ConfirmationCallback のコンストラクタとして指定されている場合は、YESNOOK、あるいは CANCEL を表す選択した確認オプション。そうでない場合は、この ConfirmationCallback のコンストラクタとして指定された options 配列のインデックスとして、選択した確認オプションを返す
関連項目:
setSelectedIndex(int)

JavaTM 2 Platform
Standard Ed. 5.0

バグの報告と機能のリクエスト
さらに詳しい API リファレンスおよび開発者ドキュメントについては、Java 2 SDK SE 開発者用ドキュメントを参照してください。開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、およびコード実例が含まれています。

Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。