001: /*
002: * $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/Engine.java,v 1.8 2002/01/14 23:37:41 remm Exp $
003: * $Revision: 1.8 $
004: * $Date: 2002/01/14 23:37:41 $
005: *
006: * ====================================================================
007: *
008: * The Apache Software License, Version 1.1
009: *
010: * Copyright (c) 1999 The Apache Software Foundation. All rights
011: * reserved.
012: *
013: * Redistribution and use in source and binary forms, with or without
014: * modification, are permitted provided that the following conditions
015: * are met:
016: *
017: * 1. Redistributions of source code must retain the above copyright
018: * notice, this list of conditions and the following disclaimer.
019: *
020: * 2. Redistributions in binary form must reproduce the above copyright
021: * notice, this list of conditions and the following disclaimer in
022: * the documentation and/or other materials provided with the
023: * distribution.
024: *
025: * 3. The end-user documentation included with the redistribution, if
026: * any, must include the following acknowlegement:
027: * "This product includes software developed by the
028: * Apache Software Foundation (http://www.apache.org/)."
029: * Alternately, this acknowlegement may appear in the software itself,
030: * if and wherever such third-party acknowlegements normally appear.
031: *
032: * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
033: * Foundation" must not be used to endorse or promote products derived
034: * from this software without prior written permission. For written
035: * permission, please contact apache@apache.org.
036: *
037: * 5. Products derived from this software may not be called "Apache"
038: * nor may "Apache" appear in their names without prior written
039: * permission of the Apache Group.
040: *
041: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
042: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
043: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
044: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
045: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
046: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
047: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
048: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
049: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
050: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
051: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
052: * SUCH DAMAGE.
053: * ====================================================================
054: *
055: * This software consists of voluntary contributions made by many
056: * individuals on behalf of the Apache Software Foundation. For more
057: * information on the Apache Software Foundation, please see
058: * <http://www.apache.org/>.
059: *
060: * [Additional notices, if required by prior licensing conditions]
061: *
062: */
063:
064: package org.apache.catalina;
065:
066: /**
067: * An <b>Engine</b> is a Container that represents the entire Catalina servlet
068: * engine. It is useful in the following types of scenarios:
069: * <ul>
070: * <li>You wish to use Interceptors that see every single request processed
071: * by the entire engine.
072: * <li>You wish to run Catalina in with a standalone HTTP connector, but still
073: * want support for multiple virtual hosts.
074: * </ul>
075: * In general, you would not use an Engine when deploying Catalina connected
076: * to a web server (such as Apache), because the Connector will have
077: * utilized the web server's facilities to determine which Context (or
078: * perhaps even which Wrapper) should be utilized to process this request.
079: * <p>
080: * The child containers attached to an Engine are generally implementations
081: * of Host (representing a virtual host) or Context (representing individual
082: * an individual servlet context), depending upon the Engine implementation.
083: * <p>
084: * If used, an Engine is always the top level Container in a Catalina
085: * hierarchy. Therefore, the implementation's <code>setParent()</code> method
086: * should throw <code>IllegalArgumentException</code>.
087: *
088: * @author Craig R. McClanahan
089: * @version $Revision: 1.8 $ $Date: 2002/01/14 23:37:41 $
090: */
091:
092: public interface Engine extends Container {
093:
094: // ------------------------------------------------------------- Properties
095:
096: /**
097: * Return the default hostname for this Engine.
098: */
099: public String getDefaultHost();
100:
101: /**
102: * Set the default hostname for this Engine.
103: *
104: * @param defaultHost The new default host
105: */
106: public void setDefaultHost(String defaultHost);
107:
108: /**
109: * Retrieve the JvmRouteId for this engine.
110: */
111: public String getJvmRoute();
112:
113: /**
114: * Set the JvmRouteId for this engine.
115: *
116: * @param jvmRouteId the (new) JVM Route ID. Each Engine within a cluster
117: * must have a unique JVM Route ID.
118: */
119: public void setJvmRoute(String jvmRouteId);
120:
121: /**
122: * Return the <code>Service</code> with which we are associated (if any).
123: */
124: public Service getService();
125:
126: /**
127: * Set the <code>Service</code> with which we are associated (if any).
128: *
129: * @param service The service that owns this Engine
130: */
131: public void setService(Service service);
132:
133: /**
134: * Set the DefaultContext
135: * for new web applications.
136: *
137: * @param defaultContext The new DefaultContext
138: */
139: public void addDefaultContext(DefaultContext defaultContext);
140:
141: // --------------------------------------------------------- Public Methods
142:
143: /**
144: * Import the DefaultContext config into a web application context.
145: *
146: * @param context web application context to import default context
147: */
148: public void importDefaultContext(Context context);
149:
150: }
|