モジュール java.base

パッケージ 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クラスを参照してください。

導入されたバージョン:

1.4

関連項目:

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用に構成されたオプション。