javax.security.auth.login
Class AppConfigurationEntry
- java.lang.Object
-
- javax.security.auth.login.AppConfigurationEntry
-
public class AppConfigurationEntry extends java.lang.Object
This class represents a singleLoginModule
entry configured for the application specified in thegetAppConfigurationEntry(String appName)
method in theConfiguration
class. Each respectiveAppConfigurationEntry
contains aLoginModule
name, a control flag (specifying whether thisLoginModule
is REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL), and LoginModule-specific options. Please refer to theConfiguration
class for more information on the different control flags and their semantics.- See Also:
Configuration
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
AppConfigurationEntry.LoginModuleControlFlag
This class represents whether or not aLoginModule
is REQUIRED, REQUISITE, SUFFICIENT or OPTIONAL.
-
Constructor Summary
Constructors Constructor and Description AppConfigurationEntry(java.lang.String loginModuleName, AppConfigurationEntry.LoginModuleControlFlag controlFlag, java.util.Map<java.lang.String,?> options)
Default constructor for this class.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description AppConfigurationEntry.LoginModuleControlFlag
getControlFlag()
Return the controlFlag (either REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL) for thisLoginModule
.java.lang.String
getLoginModuleName()
Get the class name of the configuredLoginModule
.java.util.Map<java.lang.String,?>
getOptions()
Get the options configured for thisLoginModule
.
-
-
-
Constructor Detail
-
AppConfigurationEntry
public AppConfigurationEntry(java.lang.String loginModuleName, AppConfigurationEntry.LoginModuleControlFlag controlFlag, java.util.Map<java.lang.String,?> options)
Default constructor for this class.This entry represents a single
LoginModule
entry configured for the application specified in thegetAppConfigurationEntry(String appName)
method from theConfiguration
class.- Parameters:
loginModuleName
- String representing the class name of theLoginModule
configured for the specified application.controlFlag
- either REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL.options
- the options configured for thisLoginModule
.- Throws:
java.lang.IllegalArgumentException
- ifloginModuleName
is null, ifLoginModuleName
has a length of 0, ifcontrolFlag
is not either REQUIRED, REQUISITE, SUFFICIENT or OPTIONAL, or ifoptions
is null.
-
-
Method Detail
-
getLoginModuleName
public java.lang.String getLoginModuleName()
Get the class name of the configuredLoginModule
.- Returns:
- the class name of the configured
LoginModule
as a String.
-
getControlFlag
public AppConfigurationEntry.LoginModuleControlFlag getControlFlag()
Return the controlFlag (either REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL) for thisLoginModule
.- Returns:
- the controlFlag
(either REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL)
for this
LoginModule
.
-
getOptions
public java.util.Map<java.lang.String,?> getOptions()
Get the options configured for thisLoginModule
.- Returns:
- the options configured for this
LoginModule
as an unmodifiableMap
.
-
-