javax.security.auth.login
Class AppConfigurationEntry

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by javax.security.auth.login.AppConfigurationEntry

public class AppConfigurationEntry
extends Object sample code for java.lang.Object definition code for java.lang.Object

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.

See Also:
Configuration sample code for javax.security.auth.login.Configuration definition code for javax.security.auth.login.Configuration

Nested Class Summary
static class AppConfigurationEntry.LoginModuleControlFlag sample code for javax.security.auth.login.AppConfigurationEntry.LoginModuleControlFlag definition code for javax.security.auth.login.AppConfigurationEntry.LoginModuleControlFlag
          This class represents whether or not a LoginModule is REQUIRED, REQUISITE, SUFFICIENT or OPTIONAL.
 
Constructor Summary
AppConfigurationEntry sample code for javax.security.auth.login.AppConfigurationEntry.AppConfigurationEntry(java.lang.String, javax.security.auth.login.AppConfigurationEntry.LoginModuleControlFlag, java.util.Map) definition code for javax.security.auth.login.AppConfigurationEntry.AppConfigurationEntry(java.lang.String, javax.security.auth.login.AppConfigurationEntry.LoginModuleControlFlag, java.util.Map) (String sample code for java.lang.String definition code for java.lang.String  loginModuleName, AppConfigurationEntry.LoginModuleControlFlag sample code for javax.security.auth.login.AppConfigurationEntry.LoginModuleControlFlag definition code for javax.security.auth.login.AppConfigurationEntry.LoginModuleControlFlag  controlFlag, Map sample code for java.util.Map definition code for java.util.Map <String sample code for java.lang.String definition code for java.lang.String ,?> options)
          Default constructor for this class.
 
Method Summary
 AppConfigurationEntry.LoginModuleControlFlag sample code for javax.security.auth.login.AppConfigurationEntry.LoginModuleControlFlag definition code for javax.security.auth.login.AppConfigurationEntry.LoginModuleControlFlag getControlFlag sample code for javax.security.auth.login.AppConfigurationEntry.getControlFlag() definition code for javax.security.auth.login.AppConfigurationEntry.getControlFlag() ()
          Return the controlFlag (either REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL) for this LoginModule.
 String sample code for java.lang.String definition code for java.lang.String getLoginModuleName sample code for javax.security.auth.login.AppConfigurationEntry.getLoginModuleName() definition code for javax.security.auth.login.AppConfigurationEntry.getLoginModuleName() ()
          Get the class name of the configured LoginModule.
 Map sample code for java.util.Map definition code for java.util.Map <String sample code for java.lang.String definition code for java.lang.String ,?> getOptions sample code for javax.security.auth.login.AppConfigurationEntry.getOptions() definition code for javax.security.auth.login.AppConfigurationEntry.getOptions() ()
          Get the options configured for this LoginModule.
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

AppConfigurationEntry sample code for javax.security.auth.login.AppConfigurationEntry(java.lang.String, javax.security.auth.login.AppConfigurationEntry.LoginModuleControlFlag, java.util.Map<java.lang.String, ?>) definition code for javax.security.auth.login.AppConfigurationEntry(java.lang.String, javax.security.auth.login.AppConfigurationEntry.LoginModuleControlFlag, java.util.Map<java.lang.String, ?>)

public AppConfigurationEntry(String sample code for java.lang.String definition code for java.lang.String  loginModuleName,
                             AppConfigurationEntry.LoginModuleControlFlag sample code for javax.security.auth.login.AppConfigurationEntry.LoginModuleControlFlag definition code for javax.security.auth.login.AppConfigurationEntry.LoginModuleControlFlag  controlFlag,
                             Map sample code for java.util.Map definition code for java.util.Map <String sample code for java.lang.String definition code for java.lang.String ,?> options)
Default constructor for this class.

This entry represents a single LoginModule entry configured for the application specified in the getAppConfigurationEntry(String appName) method from the Configuration class.

Parameters:
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.
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for 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

getLoginModuleName sample code for javax.security.auth.login.AppConfigurationEntry.getLoginModuleName() definition code for javax.security.auth.login.AppConfigurationEntry.getLoginModuleName()

public String sample code for java.lang.String definition code for java.lang.String  getLoginModuleName()
Get the class name of the configured LoginModule.

Returns:
the class name of the configured LoginModule as a String.

getControlFlag sample code for javax.security.auth.login.AppConfigurationEntry.getControlFlag() definition code for javax.security.auth.login.AppConfigurationEntry.getControlFlag()

public AppConfigurationEntry.LoginModuleControlFlag sample code for javax.security.auth.login.AppConfigurationEntry.LoginModuleControlFlag definition code for javax.security.auth.login.AppConfigurationEntry.LoginModuleControlFlag  getControlFlag()
Return the controlFlag (either REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL) for this LoginModule.

Returns:
the controlFlag (either REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL) for this LoginModule.

getOptions sample code for javax.security.auth.login.AppConfigurationEntry.getOptions() definition code for javax.security.auth.login.AppConfigurationEntry.getOptions()

public Map sample code for java.util.Map definition code for java.util.Map <String sample code for java.lang.String definition code for java.lang.String ,?> getOptions()
Get the options configured for this LoginModule.

Returns:
the options configured for this LoginModule as an unmodifiable Map.