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.

Since:

1.4

See Also:

• LoginContext
• security properties

Nested Class Summary

Nested classes/interfaces declared in class Configuration

Configuration.Parameters

Modifier and Type	Class	Description
static interface	Configuration.Parameters	This represents a marker interface for 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 Configuration

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

Modifier and Type	Method	Description
static Configuration	getConfiguration()	Get the installed login Configuration.
static Configuration	getInstance(String type, Configuration.Parameters params)	Returns a Configuration object of the specified type.
static Configuration	getInstance(String type, Configuration.Parameters params, String provider)	Returns a Configuration object of the specified type.
static Configuration	getInstance(String type, Configuration.Parameters params, Provider provider)	Returns a Configuration object of the specified type.
Configuration.Parameters	getParameters()	Return Configuration parameters.
Provider	getProvider()	Return the Provider of this Configuration.
String	getType()	Return the type of this Configuration.
static void	setConfiguration(Configuration configuration)	Set the login Configuration.

Methods declared in class Object

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

Modifier and Type	Method	Description
protected Object	clone()	Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
boolean	equals(Object o)	Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. May cause performance issues, deadlocks and hangs.
final Class<? extends Object>	getClass()	Answers the unique instance of java.lang.Class which represents the class of the receiver.
int	hashCode()	Answers an integer hash code for the receiver.
final void	notify()	Causes one thread which is waiting on the receiver to be made ready to run.
final void	notifyAll()	Causes all threads which are waiting on the receiver to be made ready to run.
String	toString()	Answers a string containing a concise, human-readable description of the receiver.
final void	wait()	Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
final void	wait(long time)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
final void	wait(long time, int frac)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

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 LoginModules for this application, or null if this application has no configured LoginModules.

refresh

public void refresh()

Refresh and reload the Configuration by re-reading all of the login configurations.

Overrides:

refresh in class Configuration