java.lang.Object
javax.security.auth.login.Configuration
com.sun.security.auth.login.ConfigFile
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:
 
- 
   Loop through the security properties,
   login.config.url.1, login.config.url.2, ...,
   login.config.url.X.
   Each property value specifies a URLpointing to a login configuration file to be loaded. Read in and load each configuration.
- 
   The system property
   java.security.auth.login.configmay also be set to aURLpointing 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.
- 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.
- 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:
- 
Nested Class SummaryNested classes/interfaces declared in class javax.security.auth.login.ConfigurationConfiguration.Parameters
- 
Constructor SummaryConstructorsConstructorDescriptionCreate a newConfigurationobject.ConfigFile(URI uri) Create a newConfigurationobject from the specifiedURI.
- 
Method SummaryModifier and TypeMethodDescriptiongetAppConfigurationEntry(String applicationName) Retrieve an entry from theConfigurationusing an application name as an index.voidrefresh()Refresh and reload theConfigurationby re-reading all of the login configurations.Methods declared in class javax.security.auth.login.ConfigurationgetConfiguration, getInstance, getInstance, getInstance, getParameters, getProvider, getType, setConfiguration
- 
Constructor Details- 
ConfigFilepublic ConfigFile()Create a newConfigurationobject.- Throws:
- SecurityException- if the- Configurationcan not be initialized
 
- 
ConfigFileCreate a newConfigurationobject from the specifiedURI.- Parameters:
- uri- the- URI
- Throws:
- SecurityException- if the- Configurationcan not be initialized
- NullPointerException- if- uriis null
 
 
- 
- 
Method Details- 
getAppConfigurationEntryRetrieve an entry from theConfigurationusing an application name as an index.- Specified by:
- getAppConfigurationEntryin class- Configuration
- Parameters:
- applicationName- the name used to index the- Configuration
- Returns:
- an array of AppConfigurationEntrywhich correspond to the stacked configuration ofLoginModules for this application, or null if this application has no configuredLoginModules.
 
- 
refreshpublic void refresh()Refresh and reload theConfigurationby re-reading all of the login configurations.- Overrides:
- refreshin class- Configuration
- Throws:
- SecurityException- if the caller does not have permission to refresh the- Configuration
 
 
-