org.alfresco.catalina.host

Class AVMHostConfig

java.lang.Object

org.apache.catalina.startup.HostConfig

org.alfresco.catalina.host.AVMHostConfig

All Implemented Interfaces:

org.apache.catalina.LifecycleListener

public class AVMHostConfig
extends org.apache.catalina.startup.HostConfig

Configures an AVMHost at startup time.
Note: applications never use AVMHostConfig directly.

               The Repository:  A forest of DAG structures
               -------------------------------------------

             mysite:   mysite--bob:  yoursite:   yoursite--alice:
                /           /               /            /
                |           |               |            |
               www   <~~~  www             www   <~~~   www
                |                           |
            avm_webapps                avm_webapps
             /  |  \                    /  |  \
      my_webapp    ROOT          my_webapp     ROOT
           |                          |
       moo.txt                    moo.txt

  

At startup time, the AVMHostConfig will create a "virtualized" version of avm_webapps by name-mangling the webapps within each store containing a .dns.{...} property key. The associated value is the path within this store where webapps are installed (e.g.: "mysite:/www/avm_webapps")

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.catalina.startup.HostConfig

org.apache.catalina.startup.HostConfig.DeployedApplication

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.alfresco.service.cmr.remote.AVMRemote	AVMRemote_
protected Hashtable<String,ClassLoader>	context_classloader_registry_
protected String	contextClass
protected static org.apache.commons.logging.Log	log

Fields inherited from class org.apache.catalina.startup.HostConfig

appBase, configBase, configClass, deployed, deployXML, digester, host, oname, serviced, sm, unpackWARs, xmlNamespaceAware, xmlValidation

Constructor Summary

Constructors

Constructor and Description
AVMHostConfig(String AVMHostRelativeAppBase) Creates an object that initializes an AVMHost

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addWatchedResources(org.alfresco.catalina.host.AVMHostConfig.AVMDeployedApplication app, String webapp_fullpath, org.apache.catalina.Context context)
protected void	check() The autoDepoy="true" option is a performance killer because it triggers a lot of needless calls to checkResources() and deployApps(); therefore, this null check implementation removes all possibility of this occuring.
protected void	checkResources(org.apache.catalina.startup.HostConfig.DeployedApplication app)
protected void	deployAllAVMwebappsInRepository()
protected void	deployApps() Deploy applications for any directories or WAR files that are found in our "application root" directory.
protected boolean	deployAVMdirectory(int version, String avmAppBase, String webapp_leafname, String contextPath, String parent_context_path) Deploys AVM directory.
protected void	deployAVMWebapp(int version, String avm_appBase, String webapp_leafname, String context_path, String parent_context_path) Deploy an AVM-based webapp.
protected void	deployAVMWebappDescriptorTree(org.alfresco.catalina.host.AVMHostConfig.AVMWebappDescriptor desc)
protected void	deployAVMWebappsInDependencyOrder(HashMap<String,org.alfresco.catalina.host.AVMHostConfig.AVMWebappDescriptor> webapp_descriptors)
protected ArrayList<LinkedList<String>>	getDependentWebappStores(String store_name) Fetches an array of lists of stores that are dependent upon 'store_name'.
boolean	removeAllVirtualWebapps(int version, String storePath, boolean isRecursive) Removes all virtual webapps from the store, and removes the corresponding work directory.
boolean	removeVirtualWebapp(int version, String pathToWebapp, boolean isRecursive) Removes virtual webapp from the store, and removes the corresponding work directory.
void	start()
void	stop()
protected void	undeployApps() Does a soft webapp undeploy (removes webapp entries from host).
boolean	updateAllVirtualWebapps(int version, String storePath, boolean isRecursive) Updates all virtual webapps within an AVM store; if the isRecursive flat is set, all dependent webapps are also updated (i.e.: webapps that use the one being updated as their "background" via transparency).
boolean	updateVirtualWebapp(int version, String pathToWebapp, boolean isRecursive) Updates a virtual webapps; if the isRecursive flag is set, all dependent webapps are also updated (i.e.: webapps that use the one being updated as their "background" via transparency).

Methods inherited from class org.apache.catalina.startup.HostConfig

addServiced, addWatchedResources, appBase, check, configBase, createDigester, deployApps, deployDescriptor, deployDescriptors, deployDirectories, deployDirectory, deploymentExists, deployWAR, deployWARs, getConfigBaseName, getConfigClass, getConfigFile, getContextClass, getDeploymentTime, getDocBase, getXmlNamespaceAware, getXmlValidation, isDeployXML, isServiced, isUnpackWARs, lifecycleEvent, manageApp, removeServiced, setConfigClass, setContextClass, setDeployXML, setUnpackWARs, setXmlNamespaceAware, setXmlValidation, unmanageApp

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.apache.commons.logging.Log log

context_classloader_registry_

protected Hashtable<String,ClassLoader> context_classloader_registry_

AVMRemote_

protected static org.alfresco.service.cmr.remote.AVMRemote AVMRemote_

contextClass

protected String contextClass

Constructor Detail

AVMHostConfig

public AVMHostConfig(String AVMHostRelativeAppBase)

Creates an object that initializes an AVMHost

Parameters:

AVMHostRelativeAppBase - When an AVMHost is created in $CATALINA_HOME/conf/server.xml, the value for AVMHostRelativeAppBase is taken from the appBase attribute of the <Host> tag (e.g.: "avm_webapps"). Note: even if the value provied within server.xml is an absolute path, it will be coerced into a relative path.

   <Host name="avm.localhost"
         className         ="org.alfresco.catalina.host.AVMHost"
         appBase           ="avm_webapps"
         unpackWARs        ="true"
         autoDeploy        ="false"
         xmlValidation     ="false"
         xmlNamespaceAware ="false">
   </Host>
  

Method Detail

start

public void start()

Overrides:

start in class org.apache.catalina.startup.HostConfig

stop

public void stop()

Overrides:

stop in class org.apache.catalina.startup.HostConfig

undeployApps

protected void undeployApps()

Does a soft webapp undeploy (removes webapp entries from host).

Overrides:

undeployApps in class org.apache.catalina.startup.HostConfig

deployApps

protected void deployApps()

Deploy applications for any directories or WAR files that are found in our "application root" directory.

Overrides:

deployApps in class org.apache.catalina.startup.HostConfig

deployAllAVMwebappsInRepository

protected void deployAllAVMwebappsInRepository()

updateVirtualWebapp

public boolean updateVirtualWebapp(int version,
                          String pathToWebapp,
                          boolean isRecursive)

Updates a virtual webapps; if the isRecursive flag is set, all dependent webapps are also updated (i.e.: webapps that use the one being updated as their "background" via transparency).

For example, pathToWebapp might look something like this: mysite--bob:/www/avm_webapps/ROOT. The value of 'version' is typically -1 (which corresponds to HEAD).

updateAllVirtualWebapps

public boolean updateAllVirtualWebapps(int version,
                              String storePath,
                              boolean isRecursive)

Updates all virtual webapps within an AVM store; if the isRecursive flat is set, all dependent webapps are also updated (i.e.: webapps that use the one being updated as their "background" via transparency).

For example, storePath might look something like this: mysite--bob:/www/avm_webapps/ROOT. The value of 'version' is typically -1 (which corresponds to HEAD). If the store has other webapps besides ROOT, they are updated as well.

getDependentWebappStores

protected ArrayList<LinkedList<String>> getDependentWebappStores(String store_name)

Fetches an array of lists of stores that are dependent upon 'store_name'. The initial element in this array are all the stores that are 1 hop away (e.g.: "mysite--bob" is 1 hop away from "mysite"), the subsequent element containts all stores that are 2 hops away (e.g.: "mysite--preview" is two hops away from "mysite"... and so on.

removeVirtualWebapp

public boolean removeVirtualWebapp(int version,
                          String pathToWebapp,
                          boolean isRecursive)

Removes virtual webapp from the store, and removes the corresponding work directory. This function is the logical compliment of updateVirtualWebapp.

removeAllVirtualWebapps

public boolean removeAllVirtualWebapps(int version,
                              String storePath,
                              boolean isRecursive)

Removes all virtual webapps from the store, and removes the corresponding work directory. This function is the logical compliment of updateAllVirtualWebapps.

deployAVMWebappsInDependencyOrder

protected void deployAVMWebappsInDependencyOrder(HashMap<String,org.alfresco.catalina.host.AVMHostConfig.AVMWebappDescriptor> webapp_descriptors)

deployAVMWebappDescriptorTree

protected void deployAVMWebappDescriptorTree(org.alfresco.catalina.host.AVMHostConfig.AVMWebappDescriptor desc)

deployAVMWebapp

protected void deployAVMWebapp(int version,
                   String avm_appBase,
                   String webapp_leafname,
                   String context_path,
                   String parent_context_path)

Deploy an AVM-based webapp. This is a webapp-validating wrapper for the lower-level deployment function deployAVMdirectory.

deployAVMdirectory

protected boolean deployAVMdirectory(int version,
                         String avmAppBase,
                         String webapp_leafname,
                         String contextPath,
                         String parent_context_path)

Deploys AVM directory. Requires that any directory that this dir depends on has already been deployed. If a webapp has already been deployed, treat the current deployment as a failure.

addWatchedResources

protected void addWatchedResources(org.alfresco.catalina.host.AVMHostConfig.AVMDeployedApplication app,
                       String webapp_fullpath,
                       org.apache.catalina.Context context)

check

protected void check()

The autoDepoy="true" option is a performance killer because it triggers a lot of needless calls to checkResources() and deployApps(); therefore, this null check implementation removes all possibility of this occuring.

Overrides:

check in class org.apache.catalina.startup.HostConfig

checkResources

protected void checkResources(org.apache.catalina.startup.HostConfig.DeployedApplication app)

Overrides:

checkResources in class org.apache.catalina.startup.HostConfig