FileDocCategorySizeDatePackage
AppConfigurationEntry.javaAPI DocJava SE 5 API4801Fri Aug 26 14:57:48 BST 2005javax.security.auth.login

AppConfigurationEntry

public class AppConfigurationEntry extends 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.
version
1.34, 05/05/04
see
javax.security.auth.login.Configuration

Fields Summary
private String
loginModuleName
private LoginModuleControlFlag
controlFlag
private Map
options
Constructors Summary
public AppConfigurationEntry(String loginModuleName, LoginModuleControlFlag controlFlag, Map 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.

param
loginModuleName String representing the class name of the LoginModule configured for the specified application.

param
controlFlag either REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL.

param
options the options configured for this LoginModule.
exception
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.

	if (loginModuleName == null || loginModuleName.length() == 0 ||
	    (controlFlag != LoginModuleControlFlag.REQUIRED &&
		controlFlag != LoginModuleControlFlag.REQUISITE &&
		controlFlag != LoginModuleControlFlag.SUFFICIENT &&
		controlFlag != LoginModuleControlFlag.OPTIONAL) ||
	    options == null)
	    throw new IllegalArgumentException();
	    
	this.loginModuleName = loginModuleName;
	this.controlFlag = controlFlag;
	this.options = Collections.unmodifiableMap(options);
Methods Summary
public javax.security.auth.login.AppConfigurationEntry$LoginModuleControlFlaggetControlFlag()
Return the controlFlag (either REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL) for this LoginModule.

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

	return controlFlag;
public java.lang.StringgetLoginModuleName()
Get the class name of the configured LoginModule.

return
the class name of the configured LoginModule as a String.

	return loginModuleName;
public java.util.MapgetOptions()
Get the options configured for this LoginModule.

return
the options configured for this LoginModule as an unmodifiable Map.

	return options;