Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Licensed to the Apache Software Foundation (ASF) under one or more
   * contributor license agreements.  See the NOTICE file distributed with
   * this work for additional information regarding copyright ownership.
   * The ASF licenses this file to You under the Apache License, Version 2.0
   * (the "License"); you may not use this file except in compliance with
   * the License.  You may obtain a copy of the License at
   * 
   *      http://www.apache.org/licenses/LICENSE-2.0
  * 
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 
 
 package org.apache.catalina;



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(s):
Craig R. McClanahan
Version:
$Revision: 1686 $ $Date: 2011-03-23 17:54:28 +0100 (Wed, 23 Mar 2011) $
 
 
 public interface Host extends Container {
 
 
     // ----------------------------------------------------- Manifest Constants
 

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


    
The ContainerEvent event type sent when an old alias is removed by removeAlias().
 
     public static final String REMOVE_ALIAS_EVENT = "removeAlias";
 
 
     // ------------------------------------------------------------- Properties
 

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


    
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
 
     public void setAppBase(String appBase);


    
Return the Java class name of the context configuration class for new web applications.
 
     public String getConfigClass();

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

Parameters:
configClass The new context configuration class
 
     public void setConfigClass(String configClass);

        
    
Return the default webapp name.
    public String getDefaultWebapp();


    
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
    public void setDefaultWebapp(String defaultWebapp);


    
Return the canonical, fully qualified, name of the virtual host this Container represents.
    public String getName();


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

Parameters:
name Virtual host name
Throws:
java.lang.IllegalArgumentException if name is null
    public void setName(String name);
    // --------------------------------------------------------- Public Methods


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

Parameters:
alias The alias to be added
    public void addAlias(String alias);


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


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

Parameters:
alias Alias name to be removed
    public void removeAlias(String alias);
New to GrepCode? Check out our FAQ X