compact1, compact2, compact3
javax.security.auth.login
Class AppConfigurationEntry
- 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.- See Also:
-
Configuration
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static classAppConfigurationEntry.LoginModuleControlFlagThis class represents whether or not aLoginModuleis REQUIRED, REQUISITE, SUFFICIENT or OPTIONAL.
-
Constructor Summary
Constructors Constructor and Description AppConfigurationEntry(String loginModuleName, AppConfigurationEntry.LoginModuleControlFlag controlFlag, Map<String,?> options)Default constructor for this class.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and 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
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 Detail
getLoginModuleName
public String getLoginModuleName()
Get the class name of the configuredLoginModule.- Returns:
-
the class name of the configured
LoginModuleas 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.
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
