org.apache.catalina
public interface Host extends Container
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).
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
ADD_ALIAS_EVENT
The ContainerEvent event type sent when a new alias is added
by
addAlias(). |
static java.lang.String |
REMOVE_ALIAS_EVENT
The ContainerEvent event type sent when an old alias is removed
by
removeAlias(). |
ADD_CHILD_EVENT, ADD_MAPPER_EVENT, ADD_VALVE_EVENT, REMOVE_CHILD_EVENT, REMOVE_MAPPER_EVENT, REMOVE_VALVE_EVENT| Modifier and Type | Method and Description |
|---|---|
void |
addAlias(java.lang.String alias)
Add an alias name that should be mapped to this same Host.
|
java.lang.String[] |
findAliases()
Return the set of alias names for this Host.
|
java.lang.String |
getAppBase()
Return the application root for this Host.
|
boolean |
getAutoDeploy()
Return the value of the auto deploy flag.
|
java.lang.String |
getConfigClass()
Return the Java class name of the context configuration class
for new web applications.
|
java.lang.String |
getDeployIgnore()
Return the regular expression that defines the files and directories in
the host's
#appBase that will be ignored by the automatic
deployment process. |
java.util.regex.Pattern |
getDeployIgnorePattern()
Return the compiled regular expression that defines the files and
directories in the host's
#appBase that will be ignored by the
automatic deployment process. |
boolean |
getDeployOnStartup()
Return the value of the deploy on startup flag.
|
java.lang.String |
getName()
Return the canonical, fully qualified, name of the virtual host
this Container represents.
|
boolean |
getXmlNamespaceAware()
Get the server.xml <host> attribute's xmlNamespaceAware.
|
boolean |
getXmlValidation()
Get the server.xml <host> attribute's xmlValidation.
|
Context |
map(java.lang.String uri)
Return the Context that would be used to process the specified
host-relative request URI, if any; otherwise return
null. |
void |
removeAlias(java.lang.String alias)
Remove the specified alias name from the aliases for this Host.
|
void |
setAppBase(java.lang.String appBase)
Set the application root for this Host.
|
void |
setAutoDeploy(boolean autoDeploy)
Set the auto deploy flag value for this host.
|
void |
setConfigClass(java.lang.String configClass)
Set the Java class name of the context configuration class
for new web applications.
|
void |
setDeployIgnore(java.lang.String deployIgnore)
Set the regular expression that defines the files and directories in
the host's
#appBase that will be ignored by the automatic
deployment process. |
void |
setDeployOnStartup(boolean deployOnStartup)
Set the deploy on startup flag value for this host.
|
void |
setName(java.lang.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.
|
addChild, addContainerListener, addPropertyChangeListener, backgroundProcess, findChild, findChildren, findContainerListeners, getAccessLog, getBackgroundProcessorDelay, getCluster, getInfo, getLoader, getLogger, getManager, getMappingObject, getObjectName, getParent, getParentClassLoader, getPipeline, getRealm, getResources, invoke, logAccess, removeChild, removeContainerListener, removePropertyChangeListener, setBackgroundProcessorDelay, setCluster, setLoader, setManager, setParent, setParentClassLoader, setRealm, setResourcesstatic final java.lang.String ADD_ALIAS_EVENT
addAlias().static final java.lang.String REMOVE_ALIAS_EVENT
removeAlias().java.lang.String getAppBase()
void setAppBase(java.lang.String appBase)
appBase - The new application rootboolean getAutoDeploy()
void setAutoDeploy(boolean autoDeploy)
autoDeploy - The new auto deploy flagjava.lang.String getConfigClass()
void setConfigClass(java.lang.String configClass)
configClass - The new context configuration classboolean getDeployOnStartup()
void setDeployOnStartup(boolean deployOnStartup)
deployOnStartup - The new deploy on startup flagjava.lang.String getName()
void setName(java.lang.String name)
boolean getXmlNamespaceAware()
boolean getXmlValidation()
void setXmlValidation(boolean xmlValidation)
xmlValidation - true to enable xml instance validationvoid setXmlNamespaceAware(boolean xmlNamespaceAware)
xmlNamespaceAware - true to enable namespace awarenessjava.lang.String getDeployIgnore()
#appBase that will be ignored by the automatic
deployment process.java.util.regex.Pattern getDeployIgnorePattern()
#appBase that will be ignored by the
automatic deployment process.void setDeployIgnore(java.lang.String deployIgnore)
#appBase that will be ignored by the automatic
deployment process.void addAlias(java.lang.String alias)
alias - The alias to be addedjava.lang.String[] findAliases()
Context map(java.lang.String uri)
null.uri - Request URI to be mappedvoid removeAlias(java.lang.String alias)
alias - Alias name to be removedCopyright © 2000-2013 Apache Software Foundation. All Rights Reserved.