org.apache.catalina

Interface Host

All Superinterfaces:

Container

All Known Implementing Classes:

StandardHost

public interface Host
extends Container

A Host is a Container that represents a virtual host in the Catalina servlet engine. It is useful in the following types of scenarios:

• You wish to use Interceptors that see every single request processed by this particular virtual host.
• You wish to run Catalina in with a standalone HTTP connector, but still want support for multiple virtual hosts.

In general, you would not use a Host when deploying Catalina connected to a web server (such as Apache), because the Connector will have utilized the web server's facilities to determine which Context (or perhaps even which Wrapper) should be utilized to process this request.

The parent Container attached to a Host is generally an Engine, but may be some other implementation, or may be omitted if it is not necessary.

The child containers attached to a Host are generally implementations of Context (representing an individual servlet context).

Version:

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

Author:

Craig R. McClanahan

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADD_ALIAS_EVENT The ContainerEvent event type sent when a new alias is added by addAlias().
static String	REMOVE_ALIAS_EVENT The ContainerEvent event type sent when an old alias is removed by removeAlias().

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

Method Summary

Modifier and Type	Method and Description
void	addAlias(String alias) Add an alias name that should be mapped to this same Host.
String[]	findAliases() Return the set of alias names for this Host.
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	getDefaultWebapp() Return the default webapp name.
String	getName() Return the canonical, fully qualified, name of the virtual host this Container represents.
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	setDefaultWebapp(String defaultWebapp) Set the default webapp name for this Host.
void	setName(String name) Set the canonical, fully qualified, name of the virtual host this Container represents.

Methods inherited from interface org.apache.catalina.Container

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

Field Detail

ADD_ALIAS_EVENT

static final String ADD_ALIAS_EVENT

The ContainerEvent event type sent when a new alias is added by addAlias().

See Also:

Constant Field Values

REMOVE_ALIAS_EVENT

static final String REMOVE_ALIAS_EVENT

The ContainerEvent event type sent when an old alias is removed by removeAlias().

See Also:

Constant Field Values

Method Detail

getAppBase

String getAppBase()

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

setAppBase

void setAppBase(String appBase)

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

Parameters:

appBase - The new application root

getConfigClass

String getConfigClass()

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

setConfigClass

void setConfigClass(String configClass)

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

Parameters:

configClass - The new context configuration class

getDefaultWebapp

String getDefaultWebapp()

Return the default webapp name.

setDefaultWebapp

void setDefaultWebapp(String defaultWebapp)

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

Parameters:

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

getName

String getName()

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

Specified by:

getName in interface Container

setName

void setName(String name)

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

Specified by:

setName in interface Container

Parameters:

name - Virtual host name

Throws:

IllegalArgumentException - if name is null

addAlias

void addAlias(String alias)

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

Parameters:

alias - The alias to be added

findAliases

String[] findAliases()

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

removeAlias

void removeAlias(String alias)

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

Parameters:

alias - Alias name to be removed