001: /*
002: * $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/Server.java,v 1.10 2002/03/06 06:49:10 craigmcc Exp $
003: * $Revision: 1.10 $
004: * $Date: 2002/03/06 06:49:10 $
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: import org.apache.catalina.deploy.NamingResources;
067:
068: /**
069: * A <code>Server</code> element represents the entire Catalina
070: * servlet container. Its attributes represent the characteristics of
071: * the servlet container as a whole. A <code>Server</code> may contain
072: * one or more <code>Services</code>, and the top level set of naming
073: * resources.
074: * <p>
075: * Normally, an implementation of this interface will also implement
076: * <code>Lifecycle</code>, such that when the <code>start()</code> and
077: * <code>stop()</code> methods are called, all of the defined
078: * <code>Services</code> are also started or stopped.
079: * <p>
080: * In between, the implementation must open a server socket on the port number
081: * specified by the <code>port</code> property. When a connection is accepted,
082: * the first line is read and compared with the specified shutdown command.
083: * If the command matches, shutdown of the server is initiated.
084: * <p>
085: * <strong>NOTE</strong> - The concrete implementation of this class should
086: * register the (singleton) instance with the <code>ServerFactory</code>
087: * class in its constructor(s).
088: *
089: * @author Craig R. McClanahan
090: * @version $Revision: 1.10 $ $Date: 2002/03/06 06:49:10 $
091: */
092:
093: public interface Server {
094:
095: // ------------------------------------------------------------- Properties
096:
097: /**
098: * Return descriptive information about this Server implementation and
099: * the corresponding version number, in the format
100: * <code><description>/<version></code>.
101: */
102: public String getInfo();
103:
104: /**
105: * Return the global naming resources.
106: */
107: public NamingResources getGlobalNamingResources();
108:
109: /**
110: * Set the global naming resources.
111: *
112: * @param namingResources The new global naming resources
113: */
114: public void setGlobalNamingResources(
115: NamingResources globalNamingResources);
116:
117: /**
118: * Return the port number we listen to for shutdown commands.
119: */
120: public int getPort();
121:
122: /**
123: * Set the port number we listen to for shutdown commands.
124: *
125: * @param port The new port number
126: */
127: public void setPort(int port);
128:
129: /**
130: * Return the shutdown command string we are waiting for.
131: */
132: public String getShutdown();
133:
134: /**
135: * Set the shutdown command we are waiting for.
136: *
137: * @param shutdown The new shutdown command
138: */
139: public void setShutdown(String shutdown);
140:
141: // --------------------------------------------------------- Public Methods
142:
143: /**
144: * Add a new Service to the set of defined Services.
145: *
146: * @param service The Service to be added
147: */
148: public void addService(Service service);
149:
150: /**
151: * Wait until a proper shutdown command is received, then return.
152: */
153: public void await();
154:
155: /**
156: * Return the specified Service (if it exists); otherwise return
157: * <code>null</code>.
158: *
159: * @param name Name of the Service to be returned
160: */
161: public Service findService(String name);
162:
163: /**
164: * Return the set of Services defined within this Server.
165: */
166: public Service[] findServices();
167:
168: /**
169: * Remove the specified Service from the set associated from this
170: * Server.
171: *
172: * @param service The Service to be removed
173: */
174: public void removeService(Service service);
175:
176: /**
177: * Invoke a pre-startup initialization. This is used to allow connectors
178: * to bind to restricted ports under Unix operating environments.
179: *
180: * @exception LifecycleException If this server was already initialized.
181: */
182: public void initialize() throws LifecycleException;
183: }
|