@Exported public class ConfigFile extends Configuration
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:
URL
pointing to a
login configuration file to be loaded. Read in and load
each configuration.
java.lang.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.
The configuration syntax supported by this implementation
is exactly that syntax specified in the
javax.security.auth.login.Configuration
class.
LoginContext
,
security properties
Configuration.Parameters
Constructor and Description |
---|
ConfigFile()
Create a new
Configuration object. |
ConfigFile(URI uri)
Create a new
Configuration object from the specified URI . |
Modifier and Type | Method and 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. |
getConfiguration, getInstance, getInstance, getInstance, getParameters, getProvider, getType, setConfiguration
public ConfigFile()
Configuration
object.SecurityException
- if the Configuration
can not be
initializedpublic ConfigFile(URI uri)
Configuration
object from the specified URI
.uri
- the URI
SecurityException
- if the Configuration
can not be
initializedNullPointerException
- if uri
is nullpublic AppConfigurationEntry[] getAppConfigurationEntry(String applicationName)
Configuration
using an application
name as an index.getAppConfigurationEntry
in class Configuration
applicationName
- the name used to index the Configuration
AppConfigurationEntry
which correspond to
the stacked configuration of LoginModule
s for this
application, or null if this application has no configured
LoginModule
s.public void refresh()
Configuration
by re-reading all of the
login configurations.refresh
in class Configuration
SecurityException
- if the caller does not have permission
to refresh the Configuration
Copyright © 1998, 2016, Oracle and/or its affiliates. All rights reserved.