java.lang.Object
javax.security.auth.login.AppConfigurationEntry
This class represents a single
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.- Since:
- 1.4
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
This class represents whether aLoginModule
is REQUIRED, REQUISITE, SUFFICIENT or OPTIONAL. -
Constructor Summary
ConstructorDescriptionAppConfigurationEntry
(String loginModuleName, AppConfigurationEntry.LoginModuleControlFlag controlFlag, Map<String, ?> options) Default constructor for this class. -
Method Summary
Modifier and TypeMethodDescriptionReturn the controlFlag (either REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL) for thisLoginModule
.Get the class name of the configuredLoginModule
.Get the options configured for thisLoginModule
.
-
Constructor Details
-
AppConfigurationEntry
public AppConfigurationEntry(String loginModuleName, AppConfigurationEntry.LoginModuleControlFlag controlFlag, Map<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:
IllegalArgumentException
- ifloginModuleName
is null, ifLoginModuleName
has a length of 0, ifcontrolFlag
is not either REQUIRED, REQUISITE, SUFFICIENT or OPTIONAL, or ifoptions
is null.
-
-
Method Details
-
getLoginModuleName
Get the class name of the configuredLoginModule
.- Returns:
- the class name of the configured
LoginModule
as a String.
-
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
Get the options configured for thisLoginModule
.- Returns:
- the options configured for this
LoginModule
as an unmodifiableMap
.
-