org.alfresco.catalina.host

Class AVMHost

java.lang.Object

org.apache.catalina.core.ContainerBase

org.apache.catalina.core.StandardHost

org.alfresco.catalina.host.AVMHost

All Implemented Interfaces:

Serializable, MBeanRegistration, org.apache.catalina.Container, org.apache.catalina.Host, org.apache.catalina.Lifecycle, org.apache.catalina.Pipeline

public class AVMHost
extends org.apache.catalina.core.StandardHost

This class implements a Catalina virtual Host; it can be specified as a 'className' within a Catalina <Host> node in order to fetch data from Alfresco's virtual repository, rather than from the file system. For example:

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

The addtional parameters it offers that aren't part of Catalina's StandardHost implementation are:

reverseProxyBinding

A regex that binds reverse proxy names to this Host.
Default: "^(.+)\\.www--sandbox\\.(?:version--v(-?[\\d]+)\\.)?.*$"

resourceBindingClassName

Class that maps the request to a virtual repository name/version.
Default: "org.alfresco.catalina.host.DefaultAVMResourceBinding"

Details

The reverseProxyBinding regular expression allows DNS-wildcarded requests resolving to the machine that Alfresco is running on to be mapped to an AVMHost-based virtual server within Catalina that will provide the response. This arrangement allows you to configure more than one <Host> in $CATALINA_HOME/conf/server.xml that sets:

         className ="org.alfresco.catalina.host.AVMHost"
    

For example, suppose the default Catalina virtual host is named "localhost", and it's accessed via DNS wildcarding using some other name (e.g.: "alice.mysite.www--sandbox.avm.localhost"). What's needed is a way to say "every DNS wildcard name that matches a regex pattern (reverseProxyBinding='...') should act as a reverse proxy for a particular AVMHost-based virtual host (e.g.: "avm.localhost"). If you don't provide a reverseProxyBinding attribute explicitly, the following pattern will be used:

           "^(.+)\\.www--sandbox\\.(?:version--v(-?[\\d]+)\\.)?.*$"
              ---                                --------
               ^                                    ^
               |                                    |
             group 1                             group 2
    

By default, the repository name will be taken from "group 1", and the optional version will be taken from "group 2" (see: DefaultAVMResourceBinding). The resourceBindingClassName attribute allows you to customize how a request to a reverse proxy maps to resources within the AVM repository. While org.alfresco.catalina.host.DefaultAVMResourceBinding merely takes "group 2" as a literal version number, you might want to do something more sophisticated, such as map dates to AVM version numbers; this would let you create "permalinks" that could be "guessed" by date. See the AVMResourceBinding interface for more details.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.catalina.core.ContainerBase

org.apache.catalina.core.ContainerBase.ContainerBackgroundProcessor, org.apache.catalina.core.ContainerBase.PrivilegedAddChild

Field Summary

Fields

Modifier and Type	Field and Description
protected VirtServerRegistrationThread	registrationThread_

Fields inherited from class org.apache.catalina.core.ContainerBase

backgroundProcessorDelay, children, cluster, controller, domain, lifecycle, listeners, loader, logger, logName, manager, mserver, name, oname, parent, parentClassLoader, pipeline, realm, resources, sm, started, suffix, support, type

Fields inherited from interface org.apache.catalina.Host

ADD_ALIAS_EVENT, REMOVE_ALIAS_EVENT

Fields inherited from interface org.apache.catalina.Container

ADD_CHILD_EVENT, ADD_MAPPER_EVENT, ADD_VALVE_EVENT, REMOVE_CHILD_EVENT, REMOVE_MAPPER_EVENT, REMOVE_VALVE_EVENT

Fields inherited from interface org.apache.catalina.Lifecycle

AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, DESTROY_EVENT, INIT_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT

Constructor Summary

Constructors

Constructor and Description
AVMHost()

Method Summary

Methods

Modifier and Type	Method and Description
String	getAppBase() Return the (virtual) application root for this Host.
AVMHostConfig	getAVMHostConfig()
static AVMHostMatch	getAVMHostMatch(String forwardProxyName)
String	getHostAppBase() Returns the non-virtualized appBase value specified for this host within $CATALINA_HOME/conf/server.xml.
String	getInfo() Return descriptive information about this Container implementation and the corresponding version number, in the format <description>/<version>.
boolean	getLazyDeploy()
AVMResourceBinding	getResourceBinding()
String	getResourceBindingClassName()
String	getReverseProxyBinding()
static org.springframework.context.ApplicationContext	GetSpringApplicationContext()
void	init()
void	setLazyDeploy(boolean lazyDeploy)
void	setLazyDeployExperimentalOnly(boolean lazyDeploy) Deprecated.
void	setResourceBindingClassName(String binding)
void	setReverseProxyBinding(String binding)
void	start() Start this host.
void	stop()
String	toString() Return a String representation of this component.

Methods inherited from class org.apache.catalina.core.StandardHost

addAlias, addChild, createObjectName, destroy, findAliases, getAliases, getAutoDeploy, getConfigClass, getContextClass, getDeployOnStartup, getErrorReportValveClass, getLiveDeploy, getName, getValveNames, getWorkDir, getXmlNamespaceAware, getXmlValidation, isDeployXML, isUnpackWARs, map, preRegister, removeAlias, setAppBase, setAutoDeploy, setConfigClass, setContextClass, setDeployOnStartup, setDeployXML, setErrorReportValveClass, setLiveDeploy, setName, setUnpackWARs, setWorkDir, setXmlNamespaceAware, setXmlValidation

Methods inherited from class org.apache.catalina.core.ContainerBase

addContainerListener, addLifecycleListener, addPropertyChangeListener, addValve, backgroundProcess, findChild, findChildren, findContainerListeners, findLifecycleListeners, fireContainerEvent, getBackgroundProcessorDelay, getBasic, getChildren, getCluster, getContainerSuffix, getDomain, getFirst, getJmxName, getJSR77Suffix, getLoader, getLogger, getManager, getMappingObject, getObjectName, getParent, getParentClassLoader, getParentName, getPipeline, getRealm, getResources, getType, getValveObjectNames, getValves, invoke, logName, postDeregister, postRegister, preDeregister, removeChild, removeContainerListener, removeLifecycleListener, removePropertyChangeListener, removeValve, setBackgroundProcessorDelay, setBasic, setCluster, setDomain, setLoader, setManager, setParent, setParentClassLoader, setRealm, setResources, threadStart, threadStop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.catalina.Container

addContainerListener, addPropertyChangeListener, backgroundProcess, findChild, findChildren, findContainerListeners, getBackgroundProcessorDelay, getCluster, getLoader, getLogger, getManager, getMappingObject, getObjectName, getParent, getParentClassLoader, getPipeline, getRealm, getResources, invoke, removeChild, removeContainerListener, removePropertyChangeListener, setBackgroundProcessorDelay, setCluster, setLoader, setManager, setParent, setParentClassLoader, setRealm, setResources

Field Detail

registrationThread_

protected VirtServerRegistrationThread registrationThread_

Constructor Detail

AVMHost

public AVMHost()

Method Detail

getReverseProxyBinding

public String getReverseProxyBinding()

setReverseProxyBinding

public void setReverseProxyBinding(String binding)

setLazyDeploy

public void setLazyDeploy(boolean lazyDeploy)

setLazyDeployExperimentalOnly

@Deprecated
public void setLazyDeployExperimentalOnly(boolean lazyDeploy)

Deprecated.

getLazyDeploy

public boolean getLazyDeploy()

getResourceBindingClassName

public String getResourceBindingClassName()

setResourceBindingClassName

public void setResourceBindingClassName(String binding)

getResourceBinding

public AVMResourceBinding getResourceBinding()

getAVMHostConfig

public AVMHostConfig getAVMHostConfig()

getAVMHostMatch

public static AVMHostMatch getAVMHostMatch(String forwardProxyName)

getInfo

public String getInfo()

Return descriptive information about this Container implementation and the corresponding version number, in the format <description>/<version>.

Specified by:

getInfo in interface org.apache.catalina.Container

Overrides:

getInfo in class org.apache.catalina.core.StandardHost

toString

public String toString()

Return a String representation of this component.

Overrides:

toString in class org.apache.catalina.core.StandardHost

getAppBase

public String getAppBase()

Return the (virtual) application root for this Host.

Specified by:

getAppBase in interface org.apache.catalina.Host

Overrides:

getAppBase in class org.apache.catalina.core.StandardHost

getHostAppBase

public String getHostAppBase()

Returns the non-virtualized appBase value specified for this host within $CATALINA_HOME/conf/server.xml.

GetSpringApplicationContext

public static org.springframework.context.ApplicationContext GetSpringApplicationContext()

init

public void init()

Overrides:

init in class org.apache.catalina.core.StandardHost

start

public void start()
           throws org.apache.catalina.LifecycleException

Start this host.

Specified by:

start in interface org.apache.catalina.Lifecycle

Overrides:

start in class org.apache.catalina.core.StandardHost

Throws:

org.apache.catalina.LifecycleException - if this component detects a fatal error that prevents it from being started

stop

public void stop()
          throws org.apache.catalina.LifecycleException

Specified by:

stop in interface org.apache.catalina.Lifecycle

Overrides:

stop in class org.apache.catalina.core.ContainerBase

Throws:

org.apache.catalina.LifecycleException