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.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	AppConfigurationEntry.LoginModuleControlFlag This class represents whether a `LoginModule` is REQUIRED, REQUISITE, SUFFICIENT or OPTIONAL.

Modifier and Type	Field and Description
private final AppConfigurationEntry.LoginModuleControlFlag	controlFlag
private final String	loginModuleName
private final Map<String, ?>	options

Constructor Summary

Access	Constructor and Description
public	AppConfigurationEntry(String String representing the class name of the `LoginModule` configured for the specified application. loginModuleName, AppConfigurationEntry.LoginModuleControlFlag either REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL. controlFlag, Map<String, ?> the options configured for this `LoginModule`. options) Default constructor for this class.

Method Summary

Modifier and Type	Method and Description
public AppConfigurationEntry.LoginModuleControlFlag	Returns: the controlFlag (either REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL) for this `LoginModule`. getControlFlag() Return the controlFlag (either REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL) for this `LoginModule`.
public String	Returns: the class name of the configured `LoginModule` as a String. getLoginModuleName() Get the class name of the configured `LoginModule`.
public Map<String, ?>	Returns: the options configured for this `LoginModule` as an unmodifiable `Map`. getOptions() Get the options configured for this `LoginModule`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

controlFlag	back to summary
private final AppConfigurationEntry.LoginModuleControlFlag controlFlag

loginModuleName	back to summary
private final String loginModuleName

options	back to summary
private final Map<String, ?> options

Constructor Detail

AppConfigurationEntry back to summary

AppConfigurationEntry	back to summary
public AppConfigurationEntry(String loginModuleName, AppConfigurationEntry.LoginModuleControlFlag controlFlag, Map<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 String representing the class name of the `LoginModule` configured for the specified application. controlFlag:AppConfigurationEntry.LoginModuleControlFlag either REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL. options:Map<String, ?> the options configured for this `LoginModule`. Exceptions 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 AppConfigurationEntry(String loginModuleName, AppConfigurationEntry.LoginModuleControlFlag controlFlag, Map<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: String representing the class name of the LoginModule configured for the specified application.
controlFlag:AppConfigurationEntry.LoginModuleControlFlag: either REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL.
options:Map<String, ?>: the options configured for this LoginModule.

Exceptions

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

getControlFlag back to summary

getControlFlag	back to summary
public AppConfigurationEntry.LoginModuleControlFlag getControlFlag() Return the controlFlag (either REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL) for this `LoginModule`. Returns:AppConfigurationEntry.LoginModuleControlFlag the controlFlag (either REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL) for this `LoginModule`.

public AppConfigurationEntry.LoginModuleControlFlag getControlFlag()

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

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

getLoginModuleName back to summary

getLoginModuleName	back to summary
public String getLoginModuleName() Get the class name of the configured `LoginModule`. Returns:String the class name of the configured `LoginModule` as a String.

public String getLoginModuleName()

Get the class name of the configured LoginModule.

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

getOptions back to summary

getOptions	back to summary
public Map<String, ?> getOptions() Get the options configured for this `LoginModule`. Returns:Map<String, ?> the options configured for this `LoginModule` as an unmodifiable `Map`.

public Map<String, ?> getOptions()

Get the options configured for this LoginModule.

Returns:Map<String, ?>: the options configured for this LoginModule as an unmodifiable Map.

javax.security.auth.login back to summary

public Class AppConfigurationEntry.LoginModuleControlFlag

Class Inheritance

extends Object

java.lang.Object
javax.security.auth.login.AppConfigurationEntry.LoginModuleControlFlag

This class represents whether a LoginModule is REQUIRED, REQUISITE, SUFFICIENT or OPTIONAL.

Field Summary

Modifier and Type	Field and Description
private final String	controlFlag
public static final AppConfigurationEntry.LoginModuleControlFlag	OPTIONAL Optional `LoginModule`.
public static final AppConfigurationEntry.LoginModuleControlFlag	REQUIRED Required `LoginModule`.
public static final AppConfigurationEntry.LoginModuleControlFlag	REQUISITE Requisite `LoginModule`.
public static final AppConfigurationEntry.LoginModuleControlFlag	SUFFICIENT Sufficient `LoginModule`.

Access	Constructor and Description
private	LoginModuleControlFlag(String controlFlag)

Method Summary

Modifier and Type	Method and Description
public String	Returns: a String representation of this controlFlag. toString() Overrides java.lang.Object.toString. Return a String representation of this controlFlag.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

controlFlag	back to summary
private final String controlFlag

OPTIONAL	back to summary
public static final AppConfigurationEntry.LoginModuleControlFlag OPTIONAL Optional `LoginModule`.

REQUIRED	back to summary
public static final AppConfigurationEntry.LoginModuleControlFlag REQUIRED Required `LoginModule`.

REQUISITE	back to summary
public static final AppConfigurationEntry.LoginModuleControlFlag REQUISITE Requisite `LoginModule`.

SUFFICIENT	back to summary
public static final AppConfigurationEntry.LoginModuleControlFlag SUFFICIENT Sufficient `LoginModule`.

LoginModuleControlFlag	back to summary
private LoginModuleControlFlag(String controlFlag)

Method Detail

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Return a String representation of this controlFlag. The String has the format, "LoginModuleControlFlag: flag", where flag is either required, requisite, sufficient, or optional. Returns:String a String representation of this controlFlag.

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Return a String representation of this controlFlag.

The String has the format, "LoginModuleControlFlag: flag", where flag is either required, requisite, sufficient, or optional.

Returns:String: a String representation of this controlFlag.