javax.security.auth.login

クラス AppConfigurationEntry

java.lang.Object

javax.security.auth.login.AppConfigurationEntry

public class AppConfigurationEntry
extends Object

このクラスは、Configuration クラスの getAppConfigurationEntry(String appName) メソッドで指定されたアプリケーション用に構成された、LoginModule エントリ 1 件を表します。それぞれの AppConfigurationEntry には、LoginModule の名前、制御フラグ (この LoginModule が REQUIRED、REQUISITE、SUFFICIENT、または OPTIONAL であるかどうかを指定する)、および LoginModule 固有のオプションが含まれます。それぞれの制御フラグの詳細とそのセマンティクスについては、Configuration クラスを参照してください。

関連項目:

Configuration

ネストされたクラスのサマリー

ネストされたクラス

修飾子と型	クラスと説明
static class	AppConfigurationEntry.LoginModuleControlFlag このクラスは、LoginModule が REQUIRED、REQUISITE、SUFFICIENT、または OPTIONAL であるかどうかを表します。

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

コンストラクタ

コンストラクタと説明
AppConfigurationEntry(String loginModuleName, AppConfigurationEntry.LoginModuleControlFlag controlFlag, Map<String,?> options) このクラスのデフォルトのコンストラクタです。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
AppConfigurationEntry.LoginModuleControlFlag	getControlFlag() この LoginModule の controlFlag (REQUIRED、REQUISITE、SUFFICIENT、または OPTIONAL) を返します。
String	getLoginModuleName() 構成された LoginModule のクラス名を取得します。
Map<String,?>	getOptions() この LoginModule 用に構成されたオプションを取得します。

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

AppConfigurationEntry

public AppConfigurationEntry(String loginModuleName,
                     AppConfigurationEntry.LoginModuleControlFlag controlFlag,
                     Map<String,?> options)

このクラスのデフォルトのコンストラクタです。

このエントリは、Configuration クラスの getAppConfigurationEntry(String appName) メソッドで指定されたアプリケーション用に構成された、LoginModule エントリ 1 件を表します。

パラメータ:

loginModuleName - 指定したアプリケーション用に構成された LoginModule のクラス名を表す String。

controlFlag - REQUIRED、REQUISITE、SUFFICIENT、OPTIONAL のいずれか。

options - この LoginModule 用に構成されたオプション。

例外:

IllegalArgumentException - loginModuleName が null の場合、LoginModuleName の長さが 0 の場合、controlFlag が REQUIRED、REQUISITE、SUFFICIENT、OPTIONAL のいずれでもない場合、または options が null の場合。

メソッドの詳細

getLoginModuleName

public String getLoginModuleName()

構成された LoginModule のクラス名を取得します。

戻り値:

構成された LoginModule の String クラス名。

getControlFlag

public AppConfigurationEntry.LoginModuleControlFlag getControlFlag()

この LoginModule の controlFlag (REQUIRED、REQUISITE、SUFFICIENT、または OPTIONAL) を返します。

戻り値:

この LoginModule の controlFlag (REQUIRED、REQUISITE、SUFFICIENT、または OPTIONAL)。

getOptions

public Map<String,?> getOptions()

この LoginModule 用に構成されたオプションを取得します。

戻り値:

変更不可能な Map として、この LoginModule 用に構成されたオプション。