org.apache.geronimo.web.deployment
Class AbstractWebModuleBuilder

java.lang.Object
  org.apache.geronimo.web.deployment.AbstractWebModuleBuilder

All Implemented Interfaces:

org.apache.geronimo.j2ee.deployment.ModuleBuilder

public abstract class AbstractWebModuleBuilder
extends Object
implements org.apache.geronimo.j2ee.deployment.ModuleBuilder

Field Summary

protected static org.apache.geronimo.gbean.AbstractNameQuery	ENTITY_BEAN_PATTERN
protected org.apache.geronimo.kernel.Kernel	kernel
protected static org.apache.geronimo.gbean.AbstractNameQuery	MANAGED_CONNECTION_FACTORY_PATTERN
protected org.apache.geronimo.j2ee.deployment.NamingBuilder	namingBuilders
protected org.apache.geronimo.naming.deployment.ResourceEnvironmentSetter	resourceEnvironmentSetter
protected org.apache.geronimo.deployment.NamespaceDrivenBuilderCollection	securityBuilders
protected org.apache.geronimo.deployment.NamespaceDrivenBuilderCollection	serviceBuilders
protected static org.apache.geronimo.gbean.AbstractNameQuery	STATEFUL_SESSION_BEAN_PATTERN
protected static org.apache.geronimo.gbean.AbstractNameQuery	STATELESS_SESSION_BEAN_PATTERN

Constructor Summary

protected

AbstractWebModuleBuilder(org.apache.geronimo.kernel.Kernel kernel, Collection securityBuilders, Collection serviceBuilders, org.apache.geronimo.j2ee.deployment.NamingBuilder namingBuilders, org.apache.geronimo.naming.deployment.ResourceEnvironmentSetter resourceEnvironmentSetter)

Method Summary

protected void	addPermissionToRole(String roleName, Permission permission, Map rolePermissions)
protected void	addUnmappedJSPPermissions(Set securityRoles, Map rolePermissions)
protected Map	buildServletNameToPathMap(org.apache.geronimo.xbeans.j2ee.WebAppType webApp, String contextRoot) Some servlets will have multiple url patterns.
protected org.apache.geronimo.security.jacc.ComponentPermissions	buildSpecSecurityConfig(org.apache.geronimo.xbeans.j2ee.WebAppType webApp, Set securityRoles, Map rolePermissions)
protected void	buildSubstitutionGroups(org.apache.xmlbeans.XmlObject gerWebApp, boolean hasSecurityRealmName, org.apache.geronimo.j2ee.deployment.Module module, org.apache.geronimo.j2ee.deployment.EARContext earContext)
protected static void	check(org.apache.geronimo.xbeans.j2ee.WebAppType webApp)
protected static void	checkString(String pattern)
protected static Set	collectRoleNames(org.apache.geronimo.xbeans.j2ee.WebAppType webApp)
protected static org.apache.geronimo.xbeans.j2ee.WebAppDocument	convertToServletSchema(org.apache.xmlbeans.XmlObject xmlObject)
org.apache.geronimo.j2ee.deployment.Module	createModule(File plan, JarFile moduleFile, org.apache.geronimo.kernel.Naming naming, org.apache.geronimo.deployment.ModuleIDBuilder idBuilder)
protected abstract org.apache.geronimo.j2ee.deployment.Module	createModule(Object plan, JarFile moduleFile, String targetPath, URL specDDUrl, boolean standAlone, String contextRoot, org.apache.geronimo.gbean.AbstractName earName, org.apache.geronimo.kernel.Naming naming, org.apache.geronimo.deployment.ModuleIDBuilder idBuilder)
org.apache.geronimo.j2ee.deployment.Module	createModule(Object plan, JarFile moduleFile, String targetPath, URL specDDUrl, org.apache.geronimo.kernel.repository.Environment environment, Object moduleContextInfo, org.apache.geronimo.gbean.AbstractName earName, org.apache.geronimo.kernel.Naming naming, org.apache.geronimo.deployment.ModuleIDBuilder idBuilder)
protected String	determineDefaultContextRoot(org.apache.geronimo.xbeans.j2ee.WebAppType webApp, boolean isStandAlone, JarFile moduleFile, String targetPath)
protected Set	findGBeanDependencies(org.apache.geronimo.j2ee.deployment.EARContext earContext)
org.apache.geronimo.j2ee.deployment.NamingBuilder	getNamingBuilders()
void	installModule(JarFile earFile, org.apache.geronimo.j2ee.deployment.EARContext earContext, org.apache.geronimo.j2ee.deployment.Module module, Collection configurationStores, org.apache.geronimo.kernel.config.ConfigurationStore targetConfigurationStore, Collection repositories)
protected void	processRoleRefPermissions(org.apache.geronimo.xbeans.j2ee.ServletType servletType, Set securityRoles, Map rolePermissions)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.geronimo.j2ee.deployment.ModuleBuilder

addGBeans, getSchemaNamespace, initContext

Field Detail

MANAGED_CONNECTION_FACTORY_PATTERN

protected static final org.apache.geronimo.gbean.AbstractNameQuery MANAGED_CONNECTION_FACTORY_PATTERN

STATELESS_SESSION_BEAN_PATTERN

protected static final org.apache.geronimo.gbean.AbstractNameQuery STATELESS_SESSION_BEAN_PATTERN

STATEFUL_SESSION_BEAN_PATTERN

protected static final org.apache.geronimo.gbean.AbstractNameQuery STATEFUL_SESSION_BEAN_PATTERN

ENTITY_BEAN_PATTERN

protected static final org.apache.geronimo.gbean.AbstractNameQuery ENTITY_BEAN_PATTERN

kernel

protected final org.apache.geronimo.kernel.Kernel kernel

securityBuilders

protected final org.apache.geronimo.deployment.NamespaceDrivenBuilderCollection securityBuilders

serviceBuilders

protected final org.apache.geronimo.deployment.NamespaceDrivenBuilderCollection serviceBuilders

resourceEnvironmentSetter

protected final org.apache.geronimo.naming.deployment.ResourceEnvironmentSetter resourceEnvironmentSetter

namingBuilders

protected final org.apache.geronimo.j2ee.deployment.NamingBuilder namingBuilders

Constructor Detail

AbstractWebModuleBuilder

protected AbstractWebModuleBuilder(org.apache.geronimo.kernel.Kernel kernel,
                                   Collection securityBuilders,
                                   Collection serviceBuilders,
                                   org.apache.geronimo.j2ee.deployment.NamingBuilder namingBuilders,
                                   org.apache.geronimo.naming.deployment.ResourceEnvironmentSetter resourceEnvironmentSetter)

Method Detail

getNamingBuilders

public org.apache.geronimo.j2ee.deployment.NamingBuilder getNamingBuilders()

findGBeanDependencies

protected Set findGBeanDependencies(org.apache.geronimo.j2ee.deployment.EARContext earContext)

createModule

public org.apache.geronimo.j2ee.deployment.Module createModule(File plan,
                                                               JarFile moduleFile,
                                                               org.apache.geronimo.kernel.Naming naming,
                                                               org.apache.geronimo.deployment.ModuleIDBuilder idBuilder)
                                                        throws org.apache.geronimo.common.DeploymentException

Specified by:

createModule in interface org.apache.geronimo.j2ee.deployment.ModuleBuilder

Throws:

org.apache.geronimo.common.DeploymentException

createModule

public org.apache.geronimo.j2ee.deployment.Module createModule(Object plan,
                                                               JarFile moduleFile,
                                                               String targetPath,
                                                               URL specDDUrl,
                                                               org.apache.geronimo.kernel.repository.Environment environment,
                                                               Object moduleContextInfo,
                                                               org.apache.geronimo.gbean.AbstractName earName,
                                                               org.apache.geronimo.kernel.Naming naming,
                                                               org.apache.geronimo.deployment.ModuleIDBuilder idBuilder)
                                                        throws org.apache.geronimo.common.DeploymentException

Specified by:

createModule in interface org.apache.geronimo.j2ee.deployment.ModuleBuilder

Throws:

org.apache.geronimo.common.DeploymentException

createModule

protected abstract org.apache.geronimo.j2ee.deployment.Module createModule(Object plan,
                                                                           JarFile moduleFile,
                                                                           String targetPath,
                                                                           URL specDDUrl,
                                                                           boolean standAlone,
                                                                           String contextRoot,
                                                                           org.apache.geronimo.gbean.AbstractName earName,
                                                                           org.apache.geronimo.kernel.Naming naming,
                                                                           org.apache.geronimo.deployment.ModuleIDBuilder idBuilder)
                                                                    throws org.apache.geronimo.common.DeploymentException

Throws:

org.apache.geronimo.common.DeploymentException

buildServletNameToPathMap

protected Map buildServletNameToPathMap(org.apache.geronimo.xbeans.j2ee.WebAppType webApp,
                                        String contextRoot)

Some servlets will have multiple url patterns. However, webservice servlets will only have one, which is what this method is intended for.

Parameters:

webApp -

contextRoot -

Returns:

map of servlet names to path mapped to them. Possibly inaccurate except for web services.

determineDefaultContextRoot

protected String determineDefaultContextRoot(org.apache.geronimo.xbeans.j2ee.WebAppType webApp,
                                             boolean isStandAlone,
                                             JarFile moduleFile,
                                             String targetPath)

installModule

public void installModule(JarFile earFile,
                          org.apache.geronimo.j2ee.deployment.EARContext earContext,
                          org.apache.geronimo.j2ee.deployment.Module module,
                          Collection configurationStores,
                          org.apache.geronimo.kernel.config.ConfigurationStore targetConfigurationStore,
                          Collection repositories)
                   throws org.apache.geronimo.common.DeploymentException

Specified by:

installModule in interface org.apache.geronimo.j2ee.deployment.ModuleBuilder

Throws:

org.apache.geronimo.common.DeploymentException

addUnmappedJSPPermissions

protected void addUnmappedJSPPermissions(Set securityRoles,
                                         Map rolePermissions)

buildSpecSecurityConfig

protected org.apache.geronimo.security.jacc.ComponentPermissions buildSpecSecurityConfig(org.apache.geronimo.xbeans.j2ee.WebAppType webApp,
                                                                                         Set securityRoles,
                                                                                         Map rolePermissions)

addPermissionToRole

protected void addPermissionToRole(String roleName,
                                   Permission permission,
                                   Map rolePermissions)

collectRoleNames

protected static Set collectRoleNames(org.apache.geronimo.xbeans.j2ee.WebAppType webApp)

check

protected static void check(org.apache.geronimo.xbeans.j2ee.WebAppType webApp)
                     throws org.apache.geronimo.common.DeploymentException

Throws:

org.apache.geronimo.common.DeploymentException

checkString

protected static void checkString(String pattern)
                           throws org.apache.geronimo.common.DeploymentException

Throws:

org.apache.geronimo.common.DeploymentException

processRoleRefPermissions

protected void processRoleRefPermissions(org.apache.geronimo.xbeans.j2ee.ServletType servletType,
                                         Set securityRoles,
                                         Map rolePermissions)

buildSubstitutionGroups

protected void buildSubstitutionGroups(org.apache.xmlbeans.XmlObject gerWebApp,
                                       boolean hasSecurityRealmName,
                                       org.apache.geronimo.j2ee.deployment.Module module,
                                       org.apache.geronimo.j2ee.deployment.EARContext earContext)
                                throws org.apache.geronimo.common.DeploymentException

Throws:

org.apache.geronimo.common.DeploymentException

convertToServletSchema

protected static org.apache.geronimo.xbeans.j2ee.WebAppDocument convertToServletSchema(org.apache.xmlbeans.XmlObject xmlObject)
                                                                                throws org.apache.xmlbeans.XmlException

Throws:

org.apache.xmlbeans.XmlException