public class AppConfigurationEntry extends Object
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.Configuration
Modifier and Type | Class and Description |
---|---|
static class |
AppConfigurationEntry.LoginModuleControlFlag
This class represents whether or not a
LoginModule
is REQUIRED, REQUISITE, SUFFICIENT or OPTIONAL. |
Constructor and Description |
---|
AppConfigurationEntry(String loginModuleName,
AppConfigurationEntry.LoginModuleControlFlag controlFlag,
Map<String,?> options)
Default constructor for this class.
|
Modifier and Type | Method and Description |
---|---|
AppConfigurationEntry.LoginModuleControlFlag |
getControlFlag()
Return the controlFlag
(either REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL)
for this
LoginModule . |
String |
getLoginModuleName()
Get the class name of the configured
LoginModule . |
Map<String,?> |
getOptions()
Get the options configured for this
LoginModule . |
public AppConfigurationEntry(String loginModuleName, AppConfigurationEntry.LoginModuleControlFlag controlFlag, Map<String,?> options)
This entry represents a single LoginModule
entry configured for the application specified in the
getAppConfigurationEntry(String appName)
method from the Configuration
class.
loginModuleName
- String representing the class name of the
LoginModule
configured for the
specified application. controlFlag
- either REQUIRED, REQUISITE, SUFFICIENT,
or OPTIONAL. options
- the options configured for this LoginModule
.IllegalArgumentException
- if loginModuleName
is null, if LoginModuleName
has a length of 0, if controlFlag
is not either REQUIRED, REQUISITE, SUFFICIENT
or OPTIONAL, or if options
is null.public String getLoginModuleName()
LoginModule
.LoginModule
as
a String.public AppConfigurationEntry.LoginModuleControlFlag getControlFlag()
LoginModule
.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, 2011, Oracle and/or its affiliates. All rights reserved.