org.jboss.security.microcontainer.beans
Class FlaggedPolicyModule

java.lang.Object
  extended by org.jboss.security.microcontainer.beans.BasePolicyModule
      extended by org.jboss.security.microcontainer.beans.FlaggedPolicyModule

public class FlaggedPolicyModule
extends BasePolicyModule

This class represents a flagged module, that is, a module that has a flag used to control the overall execution process. For example, the authentication login-modules specify a flag to indicate whether each module is required or not to succeed in order for the overall authentication process to be successful.

Author:
Stefan Guilhen

Field Summary
protected  AppConfigurationEntry.LoginModuleControlFlag controlFlag
          Login module control flag.
protected  String flag
          String representation of the control flag.
 
Fields inherited from class org.jboss.security.microcontainer.beans.BasePolicyModule
code, options
 
Constructor Summary
FlaggedPolicyModule()
           
 
Method Summary
 AppConfigurationEntry getAppConfigurationEntry()
           Utility method that creates an AppConfigurationEntry object using the information contained in this bean.
 String getFlag()
           Obtains the control flag of the login module.
 void setFlag(String flag)
           Sets the control flag of the login module.
 String toString()
           
 
Methods inherited from class org.jboss.security.microcontainer.beans.BasePolicyModule
getCode, getOptions, setCode, setOptions
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

flag

protected String flag
String representation of the control flag.


controlFlag

protected AppConfigurationEntry.LoginModuleControlFlag controlFlag
Login module control flag.

Constructor Detail

FlaggedPolicyModule

public FlaggedPolicyModule()
Method Detail

getFlag

public String getFlag()

Obtains the control flag of the login module.

Returns:
a String representing the control flag.

setFlag

public void setFlag(String flag)

Sets the control flag of the login module.

Parameters:
flag - a String representing the control flag to be set.

getAppConfigurationEntry

public AppConfigurationEntry getAppConfigurationEntry()

Utility method that creates an AppConfigurationEntry object using the information contained in this bean.

Returns:
a reference to the AppConfigurationEntry that has been constructed.

toString

public String toString()
Overrides:
toString in class BasePolicyModule


Copyright © 2009 JBoss Inc.. All Rights Reserved.