001: /*
002: * $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/Service.java,v 1.7 2001/11/06 22:33:46 amyroh Exp $
003: * $Revision: 1.7 $
004: * $Date: 2001/11/06 22:33:46 $
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: * A <strong>Service</strong> is a group of one or more
068: * <strong>Connectors</strong> that share a single <strong>Container</strong>
069: * to process their incoming requests. This arrangement allows, for example,
070: * a non-SSL and SSL connector to share the same population of web apps.
071: * <p>
072: * A given JVM can contain any number of Service instances; however, they are
073: * completely independent of each other and share only the basic JVM facilities
074: * and classes on the system class path.
075: *
076: * @author Craig R. McClanahan
077: * @version $Revision: 1.7 $ $Date: 2001/11/06 22:33:46 $
078: */
079:
080: public interface Service {
081:
082: // ------------------------------------------------------------- Properties
083:
084: /**
085: * Return the <code>Container</code> that handles requests for all
086: * <code>Connectors</code> associated with this Service.
087: */
088: public Container getContainer();
089:
090: /**
091: * Set the <code>Container</code> that handles requests for all
092: * <code>Connectors</code> associated with this Service.
093: *
094: * @param container The new Container
095: */
096: public void setContainer(Container container);
097:
098: /**
099: * Return descriptive information about this Service implementation and
100: * the corresponding version number, in the format
101: * <code><description>/<version></code>.
102: */
103: public String getInfo();
104:
105: /**
106: * Return the name of this Service.
107: */
108: public String getName();
109:
110: /**
111: * Set the name of this Service.
112: *
113: * @param name The new service name
114: */
115: public void setName(String name);
116:
117: /**
118: * Return the <code>Server</code> with which we are associated (if any).
119: */
120: public Server getServer();
121:
122: /**
123: * Set the <code>Server</code> with which we are associated (if any).
124: *
125: * @param server The server that owns this Service
126: */
127: public void setServer(Server server);
128:
129: // --------------------------------------------------------- Public Methods
130:
131: /**
132: * Add a new Connector to the set of defined Connectors, and associate it
133: * with this Service's Container.
134: *
135: * @param connector The Connector to be added
136: */
137: public void addConnector(Connector connector);
138:
139: /**
140: * Find and return the set of Connectors associated with this Service.
141: */
142: public Connector[] findConnectors();
143:
144: /**
145: * Remove the specified Connector from the set associated from this
146: * Service. The removed Connector will also be disassociated from our
147: * Container.
148: *
149: * @param connector The Connector to be removed
150: */
151: public void removeConnector(Connector connector);
152:
153: /**
154: * Invoke a pre-startup initialization. This is used to allow connectors
155: * to bind to restricted ports under Unix operating environments.
156: *
157: * @exception LifecycleException If this server was already initialized.
158: */
159: public void initialize() throws LifecycleException;
160:
161: }
|