org.apache.catalina

Interface Host

All Superinterfaces:
Container
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: 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: 1.8 $ $Date: 2004/02/27 14:58:38 $

Author:
Craig R. McClanahan

Field Summary

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

void
addAlias(String alias)
Add an alias name that should be mapped to this same Host.
void
addDefaultContext(DefaultContext defaultContext)
Set the DefaultContext for new web applications.
String[]
findAliases()
Return the set of alias names for this Host.
String
getAppBase()
Return the application root for this Host.
boolean
getAutoDeploy()
Return the value of the auto deploy flag.
DefaultContext
getDefaultContext()
Retrieve the DefaultContext for new web applications.
boolean
getDeployOnStartup()
Return the value of the deploy on startup flag.
String
getName()
Return the canonical, fully qualified, name of the virtual host this Container represents.
boolean
getXmlNamespaceAware()
Get the server.xml attribute's xmlNamespaceAware.
boolean
getXmlValidation()
Get the server.xml attribute's xmlValidation.
void
importDefaultContext(Context context)
Import the DefaultContext config into a web application context.
Context
map(String uri)
Return the Context that would be used to process the specified host-relative request URI, if any; otherwise return null.
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
setAutoDeploy(boolean autoDeploy)
Set the auto deploy flag value for this host.
void
setDeployOnStartup(boolean deployOnStartup)
Set the deploy on startup flag value for this host.
void
setName(String name)
Set the canonical, fully qualified, name of the virtual host this Container represents.
void
setXmlNamespaceAware(boolean xmlNamespaceAware)
Set the namespace aware feature of the XML parser used when parsing xml instances.
void
setXmlValidation(boolean xmlValidation)
Set the validation feature of the XML parser used when parsing xml instances.

Methods inherited from interface org.apache.catalina.Container

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

Field Details

ADD_ALIAS_EVENT

public static final String ADD_ALIAS_EVENT
The ContainerEvent event type sent when a new alias is added by addAlias().


REMOVE_ALIAS_EVENT

public static final String REMOVE_ALIAS_EVENT
The ContainerEvent event type sent when an old alias is removed by removeAlias().

Method Details

addAlias

public void addAlias(String alias)
Add an alias name that should be mapped to this same Host.

Parameters:
alias - The alias to be added


addDefaultContext

public void addDefaultContext(DefaultContext defaultContext)
Set the DefaultContext for new web applications.

Parameters:
defaultContext - The new DefaultContext


findAliases

public String[] findAliases()
Return the set of alias names for this Host. If none are defined, a zero length array is returned.


getAppBase

public String getAppBase()
Return the application root for this Host. This can be an absolute pathname, a relative pathname, or a URL.


getAutoDeploy

public boolean getAutoDeploy()
Return the value of the auto deploy flag. If true, it indicates that this host's child webapps should be discovred and automatically deployed dynamically.


getDefaultContext

public DefaultContext getDefaultContext()
Retrieve the DefaultContext for new web applications.


getDeployOnStartup

public boolean getDeployOnStartup()
Return the value of the deploy on startup flag. If true, it indicates that this host's child webapps should be discovred and automatically deployed.


getName

public String getName()
Return the canonical, fully qualified, name of the virtual host this Container represents.
Specified by:
getName in interface Container


getXmlNamespaceAware

public boolean getXmlNamespaceAware()
Get the server.xml attribute's xmlNamespaceAware.

Returns:
true if namespace awarenes is enabled.


getXmlValidation

public boolean getXmlValidation()
Get the server.xml attribute's xmlValidation.

Returns:
true if validation is enabled.


importDefaultContext

public void importDefaultContext(Context context)
Import the DefaultContext config into a web application context.

Parameters:
context - web application context to import default context


map

public Context map(String uri)
Return the Context that would be used to process the specified host-relative request URI, if any; otherwise return null.

Parameters:
uri - Request URI to be mapped


removeAlias

public void removeAlias(String alias)
Remove the specified alias name from the aliases for this Host.

Parameters:
alias - Alias name to be removed


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.

Parameters:
appBase - The new application root


setAutoDeploy

public void setAutoDeploy(boolean autoDeploy)
Set the auto deploy flag value for this host.

Parameters:
autoDeploy - The new auto deploy flag


setDeployOnStartup

public void setDeployOnStartup(boolean deployOnStartup)
Set the deploy on startup flag value for this host.

Parameters:
deployOnStartup - The new deploy on startup flag


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

Parameters:
name - Virtual host name


setXmlNamespaceAware

public void setXmlNamespaceAware(boolean xmlNamespaceAware)
Set the namespace aware feature of the XML parser used when parsing xml instances.

Parameters:
xmlNamespaceAware - true to enable namespace awareness


setXmlValidation

public void setXmlValidation(boolean xmlValidation)
Set the validation feature of the XML parser used when parsing xml instances.

Parameters:
xmlValidation - true to enable xml instance validation


Copyright B) 2000-2003 Apache Software Foundation. All Rights Reserved.