org.jboss.security.microcontainer.beans.metadata
Class JASPIAuthenticationMetaData

java.lang.Object
  extended by org.jboss.security.microcontainer.beans.metadata.BasePolicyMetaData
      extended by org.jboss.security.microcontainer.beans.metadata.JASPIAuthenticationMetaData

public class JASPIAuthenticationMetaData
extends BasePolicyMetaData

This class represents the <authentication-jaspi> configuration in an application policy and contains the jaspi authentication metadata information extracted by the XB parser.

The following policy excerpt shows an example of <authentication-jaspi> configuration:

  <application-policy xmlns="urn:jboss:security-beans:1.0" name="TestPolicy1">
     <authentication-jaspi>
        <login-module-stack name="ModuleStack1">
           <login-module code="org.jboss.security.auth.StackModule1" flag="required">
              <module-option name="stackOption1">stack1.value1</module-option>
           </login-module>
           <login-module code="org.jboss.security.auth.StackModule2" flag="option"/>
        </login-module-stack>
        <login-module-stack name="ModuleStack2">
           <login-module code="org.jboss.security.auth.StackModule1" flag="required">
              <module-option name="stackOption1">stack2.value1</module-option>
              <module-option name="stackOption2">stack2.value2</module-option>
           </login-module>
        </login-module-stack>
        <auth-module code="org.jboss.security.auth.AuthModule" login-module-stack-ref="ModuleStack1">
           <module-option name="authOption1">auth.value1</module-option>
           <module-option name="authOption2">auth.value2</module-option>
        </auth-module>
     </authentication-jaspi>
  ...
  </application-policy>
 
The metadata that results from the XB parsing is used by the microcontainer to create an instance of JASPIAuthenticationPolicyBean and inject this instance into the ApplicationPolicyBean that represents the application policy as a whole.

Author:
Stefan Guilhen

Field Summary
 
Fields inherited from class org.jboss.security.microcontainer.beans.metadata.BasePolicyMetaData
modules
 
Constructor Summary
JASPIAuthenticationMetaData()
           
 
Method Summary
 void addBeans(String policyName, List<org.jboss.beans.metadata.spi.BeanMetaData> beans, org.jboss.beans.metadata.spi.builder.BeanMetaDataBuilder builder)
           This method allows subclasses to add policy-specific metadata to the collection of BeanMetaData that is constructed by the getBeans(String, String) method.
 List<LoginModuleStackMetaData> getModuleStacks()
           Obtains the metadata of the module stacks.
 void setModules(List<BaseModuleMetaData> modules)
           Sets the metadata of the modules that have been specified for the policy.
 void setModuleStacks(List<LoginModuleStackMetaData> moduleStacks)
           Sets the metadata of the module stacks.
 
Methods inherited from class org.jboss.security.microcontainer.beans.metadata.BasePolicyMetaData
getBeans, getModules
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JASPIAuthenticationMetaData

public JASPIAuthenticationMetaData()
Method Detail

getModuleStacks

public List<LoginModuleStackMetaData> getModuleStacks()

Obtains the metadata of the module stacks.

Returns:
a List<LoginModuleStackMetaData> containing the module stacks metadata.

setModuleStacks

public void setModuleStacks(List<LoginModuleStackMetaData> moduleStacks)

Sets the metadata of the module stacks.

Parameters:
moduleStacks - a List<LoginModuleStackMetaData> containing the metadata to be set.

setModules

public void setModules(List<BaseModuleMetaData> modules)
Description copied from class: BasePolicyMetaData

Sets the metadata of the modules that have been specified for the policy.

Overrides:
setModules in class BasePolicyMetaData
Parameters:
modules - a List<BaseModuleMetaData> containing the metadata to be set.

addBeans

public void addBeans(String policyName,
                     List<org.jboss.beans.metadata.spi.BeanMetaData> beans,
                     org.jboss.beans.metadata.spi.builder.BeanMetaDataBuilder builder)
Description copied from class: BasePolicyMetaData

This method allows subclasses to add policy-specific metadata to the collection of BeanMetaData that is constructed by the getBeans(String, String) method.

Overrides:
addBeans in class BasePolicyMetaData
Parameters:
policyName - the name of the policy bean to be created.
beans - the collection of BeanMetaData objects that has been created and populated by the getBeans method.
builder - the BeanMetaDataBuilder used to create the BeanMetaData objects.
See Also:
BasePolicyMetaData.getBeans(String, String)


Copyright © 2009 JBoss Inc.. All Rights Reserved.