org.apache.catalina.core

Class StandardHost

java.lang.Object

org.apache.catalina.core.ContainerBase

org.apache.catalina.core.StandardHost

All Implemented Interfaces:

MBeanRegistration, Container, Host, Lifecycle, Pipeline

public class StandardHost
extends ContainerBase
implements Host

Standard implementation of the Host interface. Each child container must be a Context implementation to process the requests directed to a particular web application.

Version:

$Revision: 1686 $ $Date: 2011-03-23 17:54:28 +0100 (Wed, 23 Mar 2011) $

Author:

Craig R. McClanahan, Remy Maucherat

Nested Class Summary

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

ContainerBase.ContainerBackgroundProcessor, ContainerBase.PrivilegedAddChild

Field Summary

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

backgroundProcessorDelay, children, cluster, CONTAINER_ARRAY, controller, domain, lifecycle, LISTENER_ARRAY, listeners, loader, logger, logName, manager, mserver, name, oname, parent, parentClassLoader, pipeline, realm, resources, startChildren, 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
StandardHost() Create a new StandardHost component with the default basic Valve.

Method Summary

Modifier and Type	Method and Description
void	addAlias(String alias) Add an alias name that should be mapped to this same Host.
void	addChild(Container child) Add a child Container, only if the proposed child is an implementation of Context.
ObjectName	createObjectName(String domain, ObjectName parent)
void	destroy()
String[]	findAliases() Return the set of alias names for this Host.
String[]	getAliases()
String	getAppBase() Return the application root for this Host.
String	getConfigClass() Return the Java class name of the context configuration class for new web applications.
String	getContextClass() Return the Java class name of the Context implementation class for new web applications.
String	getDefaultWebapp() Return the default webapp name.
String	getErrorReportValveClass() Return the Java class name of the error report valve class for new web applications.
String	getInfo() Return descriptive information about this Container implementation and the corresponding version number, in the format <description>/<version>.
String	getName() Return the canonical, fully qualified, name of the virtual host this Container represents.
String[]	getValveNames() Return the MBean Names of the Valves assoicated with this Host
String	getWorkDir() Host work directory base.
void	init() Init method, part of the MBean lifecycle.
ObjectName	preRegister(MBeanServer server, ObjectName oname)
void	removeAlias(String alias) Remove the specified alias name from the aliases for this Host.
void	setAppBase(String appBase) Set the application root for this Host.
void	setConfigClass(String configClass) Set the Java class name of the context configuration class for new web applications.
void	setContextClass(String contextClass) Set the Java class name of the Context implementation class for new web applications.
void	setDefaultWebapp(String defaultWebapp) Set the default webapp name for this Host.
void	setErrorReportValveClass(String errorReportValveClass) Set the Java class name of the error report valve class for new web applications.
void	setName(String name) Set the canonical, fully qualified, name of the virtual host this Container represents.
void	setWorkDir(String workDir) Host work directory base.
void	start() Start this host.
String	toString() Return a String representation of this component.

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, getStartChildren, getType, getValveObjectNames, getValves, invoke, isStarted, logName, postDeregister, postRegister, preDeregister, removeChild, removeContainerListener, removeLifecycleListener, removePropertyChangeListener, removeValve, setBackgroundProcessorDelay, setBasic, setCluster, setDomain, setLoader, setManager, setParent, setParentClassLoader, setRealm, setResources, setStartChildren, stop, 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, fireContainerEvent, getBackgroundProcessorDelay, getCluster, getLoader, getLogger, getManager, getMappingObject, getObjectName, getParent, getParentClassLoader, getPipeline, getRealm, getResources, invoke, isStarted, removeChild, removeContainerListener, removePropertyChangeListener, setBackgroundProcessorDelay, setCluster, setLoader, setManager, setParent, setParentClassLoader, setRealm, setResources

Constructor Detail

StandardHost

public StandardHost()

Create a new StandardHost component with the default basic Valve.

Method Detail

getAppBase

public String getAppBase()

Return the application root for this Host. This can be an absolute pathname, a relative pathname, or a URL.

Specified by:

getAppBase in interface Host

setAppBase

public void setAppBase(String appBase)

Set the application root for this Host. This can be an absolute pathname, a relative pathname, or a URL.

Specified by:

setAppBase in interface Host

Parameters:

appBase - The new application root

getDefaultWebapp

public String getDefaultWebapp()

Description copied from interface: Host

Return the default webapp name.

Specified by:

getDefaultWebapp in interface Host

setDefaultWebapp

public void setDefaultWebapp(String defaultWebapp)

Description copied from interface: Host

Set the default webapp name for this Host. Defaults to "ROOT.war".

Specified by:

setDefaultWebapp in interface Host

Parameters:

defaultWebapp - The archive name of the webapp which will be mapped as the root of the host

getConfigClass

public String getConfigClass()

Return the Java class name of the context configuration class for new web applications.

Specified by:

getConfigClass in interface Host

setConfigClass

public void setConfigClass(String configClass)

Set the Java class name of the context configuration class for new web applications.

Specified by:

setConfigClass in interface Host

Parameters:

configClass - The new context configuration class

getContextClass

public String getContextClass()

Return the Java class name of the Context implementation class for new web applications.

setContextClass

public void setContextClass(String contextClass)

Set the Java class name of the Context implementation class for new web applications.

Parameters:

contextClass - The new context implementation class

getErrorReportValveClass

public String getErrorReportValveClass()

Return the Java class name of the error report valve class for new web applications.

setErrorReportValveClass

public void setErrorReportValveClass(String errorReportValveClass)

Set the Java class name of the error report valve class for new web applications.

Parameters:

errorReportValveClass - The new error report valve class

getName

public String getName()

Return the canonical, fully qualified, name of the virtual host this Container represents.

Specified by:

getName in interface Container

Specified by:

getName in interface Host

Overrides:

getName in class ContainerBase

setName

public void setName(String name)

Set the canonical, fully qualified, name of the virtual host this Container represents.

Specified by:

setName in interface Container

Specified by:

setName in interface Host

Overrides:

setName in class ContainerBase

Parameters:

name - Virtual host name

Throws:

IllegalArgumentException - if name is null

getWorkDir

public String getWorkDir()

Host work directory base.

setWorkDir

public void setWorkDir(String workDir)

Host work directory base.

addAlias

public void addAlias(String alias)

Add an alias name that should be mapped to this same Host.

Specified by:

addAlias in interface Host

Parameters:

alias - The alias to be added

addChild

public void addChild(Container child)

Add a child Container, only if the proposed child is an implementation of Context.

Specified by:

addChild in interface Container

Overrides:

addChild in class ContainerBase

Parameters:

child - Child container to be added

findAliases

public String[] findAliases()

Return the set of alias names for this Host. If none are defined, a zero length array is returned.

Specified by:

findAliases in interface Host

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 Container

Overrides:

getInfo in class ContainerBase

removeAlias

public void removeAlias(String alias)

Remove the specified alias name from the aliases for this Host.

Specified by:

removeAlias in interface Host

Parameters:

alias - Alias name to be removed

toString

public String toString()

Return a String representation of this component.

Overrides:

toString in class Object

start

public void start()
           throws LifecycleException

Start this host.

Specified by:

start in interface Lifecycle

Overrides:

start in class ContainerBase

Throws:

LifecycleException - if this component detects a fatal error that prevents it from being started

getValveNames

public String[] getValveNames()
                       throws Exception

Return the MBean Names of the Valves assoicated with this Host

Throws:

Exception - if an MBean cannot be created or registered

getAliases

public String[] getAliases()

init

public void init()

Description copied from class: ContainerBase

Init method, part of the MBean lifecycle. If the container was added via JMX, it'll register itself with the parent, using the ObjectName conventions to locate the parent. If the container was added directly and it doesn't have an ObjectName, it'll create a name and register itself with the JMX console. On destroy(), the object will unregister.

Overrides:

init in class ContainerBase

destroy

public void destroy()
             throws Exception

Overrides:

destroy in class ContainerBase

Throws:

Exception

preRegister

public ObjectName preRegister(MBeanServer server,
                              ObjectName oname)
                       throws Exception

Specified by:

preRegister in interface MBeanRegistration

Overrides:

preRegister in class ContainerBase

Throws:

Exception

createObjectName

public ObjectName createObjectName(String domain,
                                   ObjectName parent)
                            throws Exception

Overrides:

createObjectName in class ContainerBase

Throws:

Exception