ConfigFile (Java SE 22 & JDK 22)
Description: declaration: module: jdk.security.auth, package: com.sun.security.auth.login, class: ConfigFile
Keywords: com.sun.security.auth.login.ConfigFile class

Module jdk.security.auth
Package com.sun.security.auth.login

# Class ConfigFile

java.lang.Object
javax.security.auth.login.Configuration
com.sun.security.auth.login.ConfigFile

public class ConfigFile extends Configuration
This class represents a default implementation for `javax.security.auth.login.Configuration`.

This object stores the runtime login configuration representation, and is the amalgamation of multiple static login configurations that resides in files. The algorithm for locating the login configuration file(s) and reading their information into this `Configuration` object is:

1. Loop through the security properties, login.config.url.1, login.config.url.2, ..., login.config.url.X. Each property value specifies a `URL` pointing to a login configuration file to be loaded. Read in and load each configuration.
2. The system property `java.security.auth.login.config` may also be set to a `URL` pointing to another login configuration file (which is the case when a user uses the -D switch at runtime). If this property is defined, and its use is allowed by the security property file (the Security property, policy.allowSystemProperty is set to true), also load that login configuration.
3. If the java.security.auth.login.config property is defined using "==" (rather than "="), then ignore all other specified login configurations and only load this configuration.
4. If no system or security properties were set, try to read from the file, ${user.home}/.java.login.config, where ${user.home} is the value represented by the "user.home" System property.

The configuration syntax supported by this implementation is exactly that syntax specified in the `javax.security.auth.login.Configuration` class. In addition, the security property policy.expandProperties can be used to control whether system properties in the configuration file are expanded. If not set, the default value is true which means that properties will be expanded.

See Also:
  - `LoginContext`
  - security properties

- ## Nested Class Summary

  ### Nested classes/interfaces declared in class javax.security.auth.login.Configuration

  `Configuration.Parameters`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `ConfigFile()`
  Create a new `Configuration` object.
  `ConfigFile(URI uri)`
  Create a new `Configuration` object from the specified `URI`.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `AppConfigurationEntry[]`
  `getAppConfigurationEntry(String applicationName)`
  Retrieve an entry from the `Configuration` using an application name as an index.
  `void`
  `refresh()`
  Refresh and reload the `Configuration` by re-reading all of the login configurations.

  ### Methods declared in class javax.security.auth.login.Configuration

  `getConfiguration, getInstance, getInstance, getInstance, getParameters, getProvider, getType, setConfiguration`

  ### Methods declared in class java.lang.Object

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

- ## Constructor Details

  - ### ConfigFile

    public ConfigFile()
    Create a new `Configuration` object.
    Throws:
      `SecurityException` - if the `Configuration` can not be initialized

  - ### ConfigFile

    public ConfigFile(URI uri)
    Create a new `Configuration` object from the specified `URI`.
    Parameters:
      `uri` - the `URI`
    Throws:
      `SecurityException` - if the `Configuration` can not be initialized
      `NullPointerException` - if `uri` is null

- ## Method Details

  - ### getAppConfigurationEntry

    public AppConfigurationEntry[] getAppConfigurationEntry(String applicationName)
    Retrieve an entry from the `Configuration` using an application name as an index.
    Specified by:
      `getAppConfigurationEntry` in class `Configuration`
    Parameters:
      `applicationName` - the name used to index the `Configuration`
    Returns:
      an array of `AppConfigurationEntry` which correspond to the stacked configuration of `LoginModule`s for this application, or null if this application has no configured `LoginModule`s.

  - ### refresh

    public void refresh()
    Refresh and reload the `Configuration` by re-reading all of the login configurations.
    Overrides:
      `refresh` in class `Configuration`
    Throws:
      `SecurityException` - if the caller does not have permission to refresh the `Configuration`