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
Nested ClassesModifier and TypeClassDescriptionstatic classThis class represents whether aLoginModuleis REQUIRED, REQUISITE, SUFFICIENT or OPTIONAL. -
Constructor Summary
ConstructorsConstructorDescriptionAppConfigurationEntry(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
LoginModuleentry configured for the application specified in thegetAppConfigurationEntry(String appName)method from theConfigurationclass.- Parameters:
loginModuleName- String representing the class name of theLoginModuleconfigured for the specified application.controlFlag- either REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL.options- the options configured for thisLoginModule.- Throws:
IllegalArgumentException- ifloginModuleNameis null, ifLoginModuleNamehas a length of 0, ifcontrolFlagis not either REQUIRED, REQUISITE, SUFFICIENT or OPTIONAL, or ifoptionsis null.
-
-
Method Details
-
getLoginModuleName
Get the class name of the configuredLoginModule.- Returns:
- the class name of the configured
LoginModuleas 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
LoginModuleas an unmodifiableMap.
-