- java.lang.Object
- 
- javax.security.auth.login.AppConfigurationEntry
 
- 
 public class AppConfigurationEntry extends Object This class represents a singleLoginModuleentry configured for the application specified in thegetAppConfigurationEntry(String appName)method in theConfigurationclass. Each respectiveAppConfigurationEntrycontains aLoginModulename, a control flag (specifying whether thisLoginModuleis REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL), and LoginModule-specific options. Please refer to theConfigurationclass for more information on the different control flags and their semantics.- Since:
- 1.4
- See Also:
- Configuration
 
- 
- 
Nested Class SummaryNested Classes Modifier and Type Class Description static classAppConfigurationEntry.LoginModuleControlFlagThis class represents whether or not aLoginModuleis REQUIRED, REQUISITE, SUFFICIENT or OPTIONAL.
 - 
Constructor SummaryConstructors Constructor Description AppConfigurationEntry(String loginModuleName, AppConfigurationEntry.LoginModuleControlFlag controlFlag, Map<String,?> options)Default constructor for this class.
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description AppConfigurationEntry.LoginModuleControlFlaggetControlFlag()Return the controlFlag (either REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL) for thisLoginModule.StringgetLoginModuleName()Get the class name of the configuredLoginModule.Map<String,?>getOptions()Get the options configured for thisLoginModule.
 
- 
- 
- 
Constructor Detail- 
AppConfigurationEntrypublic 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 the- LoginModuleconfigured for the specified application.
- controlFlag- either REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL.
- options- the options configured for this- LoginModule.
- Throws:
- IllegalArgumentException- if- loginModuleNameis null, if- LoginModuleNamehas a length of 0, if- controlFlagis not either REQUIRED, REQUISITE, SUFFICIENT or OPTIONAL, or if- optionsis null.
 
 
- 
 - 
Method Detail- 
getLoginModuleNamepublic String getLoginModuleName() Get the class name of the configuredLoginModule.- Returns:
- the class name of the configured LoginModuleas a String.
 
 - 
getControlFlagpublic 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.
 
 
- 
 
-