Save This Page
Home » glassfish-v2ur2-b04-src » org.apache » catalina » [javadoc | source]
org.apache.catalina
public interface: Host [javadoc | source]

All Implemented Interfaces:
    Container

All Known Implementing Classes:
    PEVirtualServer, VirtualServer, StandardHost

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).

Field Summary
public static final  String ADD_ALIAS_EVENT    The ContainerEvent event type sent when a new alias is added by addAlias(). 
public static final  String REMOVE_ALIAS_EVENT    The ContainerEvent event type sent when an old alias is removed by removeAlias(). 
Method from org.apache.catalina.Host Summary:
addAlias,   addDefaultContext,   findAliases,   getAppBase,   getAutoDeploy,   getDefaultContext,   getDeployOnStartup,   getName,   getPorts,   getXmlNamespaceAware,   getXmlValidation,   importDefaultContext,   map,   removeAlias,   setAppBase,   setAutoDeploy,   setDeployOnStartup,   setName,   setPorts,   setXmlNamespaceAware,   setXmlValidation
Method from org.apache.catalina.Host Detail:
 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. If none are defined,
a zero length array is returned.
 public String getAppBase()
    Return the application root for this Host. This can be an absolute
pathname, a relative pathname, or a URL.
 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.
 public DefaultContext getDefaultContext()
    Retrieve the DefaultContext for new web applications.
 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.
 public String getName()
    Return the canonical, fully qualified, name of the virtual host
this Container represents.
 public int[] getPorts()
    Gets the port numbers with which this Host is associated.
 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. This can be an absolute
pathname, a relative pathname, or a URL.
 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 setPorts(int[] ports)
    Associates this Host with the given port numbers.
 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.