| org.apache.catalina.Host
All known Subclasses: org.apache.catalina.core.StandardHost,
| Host | | public interface Host extends Container(Code) | | 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).
author:
Craig R. McClanahan
version:
$Revision: 1.8 $ $Date: 2004/02/27 14:58:38 $ |
| Field Summary | |
| final public static String | ADD_ALIAS_EVENT
The ContainerEvent event type sent when a new alias is added
by addAlias(). | | final public static String | REMOVE_ALIAS_EVENT
The ContainerEvent event type sent when an old alias is removed
by removeAlias(). |
| Method Summary | |
| public void | addAlias(String alias)
Add an alias name that should be mapped to this same Host. | | public void | addDefaultContext(DefaultContext defaultContext)
Set the DefaultContext
for new web applications. | | public String[] | findAliases()
Return the set of alias names for this Host. | | public String | getAppBase()
Return the application root for this Host. | | public boolean | getAutoDeploy()
Return the value of the auto deploy flag. | | public DefaultContext | getDefaultContext()
Retrieve the DefaultContext for new web applications. | | public boolean | getDeployOnStartup()
Return the value of the deploy on startup flag. | | public String | getName()
Return the canonical, fully qualified, name of the virtual host
this Container represents. | | public boolean | getXmlNamespaceAware()
Get the server.xml attribute's xmlNamespaceAware. | | public boolean | getXmlValidation()
Get the server.xml attribute's xmlValidation. | | public void | importDefaultContext(Context context)
Import the DefaultContext config into a web application context. | | 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. | | public void | removeAlias(String alias)
Remove the specified alias name from the aliases for this Host. | | public void | setAppBase(String appBase)
Set the application root for this Host. | | public void | setAutoDeploy(boolean autoDeploy)
Set the auto deploy flag value for this host. | | public void | setDeployOnStartup(boolean deployOnStartup)
Set the deploy on startup flag value for this host. | | public void | setName(String name)
Set the canonical, fully qualified, name of the virtual host
this Container represents. | | public void | setXmlNamespaceAware(boolean xmlNamespaceAware)
Set the namespace aware feature of the XML parser used when
parsing xml instances. | | public void | setXmlValidation(boolean xmlValidation)
Set the validation feature of the XML parser used when
parsing xml instances. |
| ADD_ALIAS_EVENT | | final public static String ADD_ALIAS_EVENT(Code) | | The ContainerEvent event type sent when a new alias is added
by addAlias().
|
| REMOVE_ALIAS_EVENT | | final public static String REMOVE_ALIAS_EVENT(Code) | | The ContainerEvent event type sent when an old alias is removed
by removeAlias().
|
| addAlias | | public void addAlias(String alias)(Code) | | 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)(Code) | | Set the DefaultContext
for new web applications.
Parameters:
defaultContext - The new DefaultContext |
| findAliases | | public String[] findAliases()(Code) | | Return the set of alias names for this Host. If none are defined,
a zero length array is returned.
|
| getAppBase | | public String getAppBase()(Code) | | Return the application root for this Host. This can be an absolute
pathname, a relative pathname, or a URL.
|
| getAutoDeploy | | public boolean getAutoDeploy()(Code) | | 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()(Code) | | Retrieve the DefaultContext for new web applications.
|
| getDeployOnStartup | | public boolean getDeployOnStartup()(Code) | | 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()(Code) | | Return the canonical, fully qualified, name of the virtual host
this Container represents.
|
| getXmlNamespaceAware | | public boolean getXmlNamespaceAware()(Code) | | Get the server.xml attribute's xmlNamespaceAware.
true if namespace awarenes is enabled. |
| getXmlValidation | | public boolean getXmlValidation()(Code) | | Get the server.xml attribute's xmlValidation.
true if validation is enabled. |
| importDefaultContext | | public void importDefaultContext(Context context)(Code) | | Import the DefaultContext config into a web application context.
Parameters:
context - web application context to import default context |
| map | | public Context map(String uri)(Code) | | 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)(Code) | | Remove the specified alias name from the aliases for this Host.
Parameters:
alias - Alias name to be removed |
| setAppBase | | public void setAppBase(String appBase)(Code) | | 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)(Code) | | Set the auto deploy flag value for this host.
Parameters:
autoDeploy - The new auto deploy flag |
| setDeployOnStartup | | public void setDeployOnStartup(boolean deployOnStartup)(Code) | | Set the deploy on startup flag value for this host.
Parameters:
deployOnStartup - The new deploy on startup flag |
| setName | | public void setName(String name)(Code) | | Set the canonical, fully qualified, name of the virtual host
this Container represents.
Parameters:
name - Virtual host name
exception:
IllegalArgumentException - if name is null |
| setXmlNamespaceAware | | public void setXmlNamespaceAware(boolean xmlNamespaceAware)(Code) | | 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)(Code) | | Set the validation feature of the XML parser used when
parsing xml instances.
Parameters:
xmlValidation - true to enable xml instance validation |
|
|