public class AppConfigurationEntry extends Object
LoginModule
entry configured for the application specified in the getAppConfigurationEntry(String appName)
method in the Configuration
class. Each respective AppConfigurationEntry
contains a LoginModule
name, a control flag (specifying whether this LoginModule
is REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL), and LoginModule-specific options. Please refer to the Configuration
class for more information on the different control flags and their semantics.Modifier and Type | Class | Description |
---|---|---|
static class |
AppConfigurationEntry.LoginModuleControlFlag |
This class represents whether a LoginModule is REQUIRED, REQUISITE, SUFFICIENT or OPTIONAL. |
Constructor | Description |
---|---|
AppConfigurationEntry |
Default constructor for this class. |
Modifier and Type | Method | Description |
---|---|---|
AppConfigurationEntry.LoginModuleControlFlag |
getControlFlag() |
Return the controlFlag (either REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL) for this LoginModule . |
String |
getLoginModuleName() |
Get the class name of the configured LoginModule . |
Map |
getOptions() |
Get the options configured for this LoginModule . |
public AppConfigurationEntry(String loginModuleName, AppConfigurationEntry.LoginModuleControlFlag controlFlag, Map<String,?> options)
This entry represents a single LoginModule
entry configured for the application specified in the getAppConfigurationEntry(String appName)
method from the Configuration
class.
loginModuleName
- String representing the class name of the LoginModule
configured for the specified application.controlFlag
- either REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL.options
- the options configured for this LoginModule
.IllegalArgumentException
- if loginModuleName
is null, if LoginModuleName
has a length of 0, if controlFlag
is not either REQUIRED, REQUISITE, SUFFICIENT or OPTIONAL, or if options
is null.public String getLoginModuleName()
LoginModule
.LoginModule
as a String.public AppConfigurationEntry.LoginModuleControlFlag getControlFlag()
LoginModule
.LoginModule
.public Map<String,?> getOptions()
LoginModule
.LoginModule
as an unmodifiable Map
.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/javax/security/auth/login/AppConfigurationEntry.html