モジュール jdk.security.auth
パッケージ com.sun.security.auth.login

クラスConfigFile

java.lang.Object
javax.security.auth.login.Configuration
com.sun.security.auth.login.ConfigFile
public class ConfigFile extends Configuration
このクラスはjavax.security.auth.login.Configurationのデフォルトの実装を表します。

実行時のログイン構成表現を格納し、複数のファイル内にある複数の静的なログイン構成を合わせます。 ログイン構成ファイルを検出し、その情報をこのConfigurationに読み込むアルゴリズムは次のとおりです。

  1. セキュリティ・プロパティlogin.config.url.1、login.config.url.2、...、login.config.url.Xに対してループ処理を行います。 それぞれのプロパティ値では、ロードされるログイン構成ファイルを参照するURLを指定します。 各構成が読み込まれ、ロードされます。
  2. システム・プロパティjava.security.auth.login.configは、別のログイン構成ファイル(ユーザーが実行時に -Dスイッチを使用した場合)を指すURLに設定することもできます。 このプロパティが定義されており、このプロパティの使用がセキュリティ・プロパティ・ファイルで許可されている(セキュリティ・プロパティpolicy.allowSystemPropertyがtrue)場合は、そのログイン構成もロードされます。
  3. java.security.auth.login.configプロパティが「==」(「=」ではない)を使用して定義されている場合、ほかに指定したログイン構成はすべて無視され、この構成だけがロードされます。
  4. システム・プロパティやセキュリティ・プロパティが設定されていない場合は、${user.home}/.java.login.configファイルからの読込みが試みられます(${user.home}はuser.homeシステム・プロパティで表される値)。

この実装でサポートされる構成構文は、javax.security.auth.login.Configurationクラスで指定した構文です。 また、セキュリティ・プロパティpolicy.expandPropertiesを使用して、構成ファイルのシステム・プロパティを展開するかどうかを制御できます。 設定しない場合、デフォルト値はtrueで、プロパティが展開されることを意味します。

関連項目:
LoginContext, セキュリティ・プロパティ

  • コンストラクタの詳細

    • ConfigFile

      public ConfigFile()
      新しいConfigurationオブジェクトを作成します。
      例外:
      SecurityException - Configurationを初期化できない場合

    • ConfigFile

      public ConfigFile​(URI uri)
      指定されたURIから新しいConfigurationオブジェクトを作成します。
      パラメータ:
      uri - URI
      例外:
      SecurityException - Configurationを初期化できない場合
      NullPointerException - uriがnullの場合

  • メソッドの詳細

    • getAppConfigurationEntry

      public AppConfigurationEntry[] getAppConfigurationEntry​(String applicationName)
      アプリケーション名をインデックスとして使用しているConfigurationからのエントリを取得します。
      定義:
      getAppConfigurationEntry 、クラス:  Configuration
      パラメータ:
      applicationName - Configurationのインデックスとして使用される名前
      戻り値:
      このアプリケーション用にスタックされたLoginModuleの構成に対応する、AppConfigurationEntryの配列。LoginModuleが構成されていない場合はnull。

    • refresh

      public void refresh()
      すべてのログイン構成を読み込み直すことで、Configurationをリフレッシュし、再ロードします。
      オーバーライド:
      refresh 、クラス:  Configuration
      例外:
      SecurityException - 呼出し側にConfigurationをリフレッシュするアクセス権がない場合