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

java.lang.Object
  org.jboss.security.microcontainer.beans.metadata.BasePolicyMetaData

Direct Known Subclasses:

AuditMetaData, AuthenticationMetaData, AuthorizationMetaData, IdentityTrustMetaData, JASPIAuthenticationMetaData, RoleMappingMetaData

public class BasePolicyMetaData
extends Object

Superclass of all policies that form an application-policy. It defines the metadata common to all policies.

Author:

Stefan Guilhen

Field Summary

protected List<BaseModuleMetaData>

modules the collection of the modules specified for the policy.

Constructor Summary

BasePolicyMetaData()

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 being constructed by the getBeans(String, String) method.
List<org.jboss.beans.metadata.spi.BeanMetaData>	getBeans(String policyName, String beanClass) Creates the BeanMetaData objects that will be used by the microcontainer to create and populate an instance of the policy bean.
List<BaseModuleMetaData>	getModules() Obtains the metadata of the modules that have been specified for the policy.
void	setModules(List<BaseModuleMetaData> modules) Sets the metadata of the modules that have been specified for the policy.

Methods inherited from class java.lang.Object

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

Field Detail

modules

protected List<BaseModuleMetaData> modules

the collection of the modules specified for the policy.

Constructor Detail

BasePolicyMetaData

public BasePolicyMetaData()

Method Detail

getModules

public List<BaseModuleMetaData> getModules()

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

Returns:

a List<BaseModuleMetaData> containig the metadata of the modules.

setModules

public void setModules(List<BaseModuleMetaData> modules)

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

Parameters:

modules - a List<BaseModuleMetaData> containing the metadata to be set.

getBeans

public List<org.jboss.beans.metadata.spi.BeanMetaData> getBeans(String policyName,
                                                                String beanClass)

Creates the BeanMetaData objects that will be used by the microcontainer to create and populate an instance of the policy bean.

Parameters:

policyName - the name of the policy bean to be created.

beanClass - the class name of the policy bean.

Returns:

a List containing all BeanMetaData objects needed to create the policy bean and its modules.

addBeans

public 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 being constructed by the getBeans(String, String) method.

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:

getBeans(String, String)