Package org.jboss.security.auth.container.config

Class AuthModuleEntry

java.lang.Object

org.jboss.security.auth.container.config.AuthModuleEntry

public class AuthModuleEntry
extends Object

Represents a configuration for a single auth module along the lines of AppConfigurationEntry for a JAAS LoginModule

Since:

Dec 20, 2005

Author:

Constructor Summary

Constructors

Constructor	Description
AuthModuleEntry(String authModuleName, Map<String,Object> options, String loginModuleStackHolderName)	Create a new AuthModuleEntry.

Method Summary

Modifier and Type	Method	Description
void	addOption(ModuleOption option)
String	getAuthModuleName()	Get the name of the configured AuthModule
ControlFlag	getControlFlag()
LoginModuleStackHolder	getLoginModuleStackHolder()	A ServerAuthModule may delegate its decision making to a stack of LoginModules
String	getLoginModuleStackHolderName()
Map<String,Object>	getOptions()	Get the options configured for this AuthModule.
void	setControlFlag(ControlFlag flag)
void	setLoginModuleStackHolder(LoginModuleStackHolder loginModuleStackHolder)	A ServerAuthModule may delegate its decision making to a stack of LoginModules
void	setLoginModuleStackHolderName(String loginModuleStackHolderName)
void	setOptions(Map<String,Object> options)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AuthModuleEntry

public AuthModuleEntry(String authModuleName,
                       Map<String,Object> options,
                       String loginModuleStackHolderName)

Create a new AuthModuleEntry.

Parameters:

authModuleName - Name of the AuthModule

options - the options configured for this AuthModule.

loginModuleStackHolderName - Name of the LoginModuleStack (Can be Null

Method Detail

getAuthModuleName

public String getAuthModuleName()

Get the name of the configured AuthModule

Returns:

the class name of the configured AuthModule as a String.

addOption

public void addOption(ModuleOption option)

getOptions

public Map<String,Object> getOptions()

Get the options configured for this AuthModule.

Returns:

the options configured for this AuthModule as an unmodifiable Map

setOptions

public void setOptions(Map<String,Object> options)

getLoginModuleStackHolder

public LoginModuleStackHolder getLoginModuleStackHolder()

A ServerAuthModule may delegate its decision making to a stack of LoginModules

Returns:

a stack of LoginModules

setLoginModuleStackHolder

public void setLoginModuleStackHolder(LoginModuleStackHolder loginModuleStackHolder)

A ServerAuthModule may delegate its decision making to a stack of LoginModules

Parameters:

loginModuleStackHolder - a stack of LoginModules

getLoginModuleStackHolderName

public String getLoginModuleStackHolderName()

setLoginModuleStackHolderName

public void setLoginModuleStackHolderName(String loginModuleStackHolderName)

getControlFlag

public ControlFlag getControlFlag()

setControlFlag

public void setControlFlag(ControlFlag flag)

toString

public String toString()

Overrides:

toString in class Object