|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjavax.security.auth.login.AppConfigurationEntry
public class 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.
Configuration| Nested Class Summary | |
|---|---|
static class |
AppConfigurationEntry.LoginModuleControlFlag
This class represents whether or not a LoginModule
is REQUIRED, REQUISITE, SUFFICIENT or OPTIONAL. |
| Constructor Summary | |
|---|---|
AppConfigurationEntry(java.lang.String loginModuleName,
AppConfigurationEntry.LoginModuleControlFlag controlFlag,
java.util.Map<java.lang.String,?> options)
Default constructor for this class. |
|
| Method Summary | |
|---|---|
AppConfigurationEntry.LoginModuleControlFlag |
getControlFlag()
Return the controlFlag (either REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL) for this LoginModule. |
java.lang.String |
getLoginModuleName()
Get the class name of the configured LoginModule. |
java.util.Map<java.lang.String,?> |
getOptions()
Get the options configured for this LoginModule. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public AppConfigurationEntry(java.lang.String loginModuleName,
AppConfigurationEntry.LoginModuleControlFlag controlFlag,
java.util.Map<java.lang.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.
java.lang.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.| Method Detail |
|---|
public java.lang.String getLoginModuleName()
LoginModule.
LoginModule as
a String.public AppConfigurationEntry.LoginModuleControlFlag getControlFlag()
LoginModule.
LoginModule.public java.util.Map<java.lang.String,?> getOptions()
LoginModule.
LoginModule
as an unmodifiable Map.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||