001: /*
002: * Copyright 1999,2004 The Apache Software Foundation.
003: *
004: * Licensed under the Apache License, Version 2.0 (the "License");
005: * you may not use this file except in compliance with the License.
006: * You may obtain a copy of the License at
007: *
008: * http://www.apache.org/licenses/LICENSE-2.0
009: *
010: * Unless required by applicable law or agreed to in writing, software
011: * distributed under the License is distributed on an "AS IS" BASIS,
012: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013: * See the License for the specific language governing permissions and
014: * limitations under the License.
015: */
016:
017: package org.apache.catalina;
018:
019: import org.apache.catalina.net.ServerSocketFactory;
020:
021: /**
022: * A <b>Connector</b> is a component responsible receiving requests from,
023: * and returning responses to, a client application. A Connector performs
024: * the following general logic:
025: * <ul>
026: * <li>Receive a request from the client application.
027: * <li>Create (or allocate from a pool) appropriate Request and Response
028: * instances, and populate their properties based on the contents of
029: * the received request, as described below.
030: * <ul>
031: * <li>For all Requests, the <code>connector</code>,
032: * <code>protocol</code>, <code>remoteAddr</code>,
033: * <code>response</code>, <code>scheme</code>,
034: * <code>secure</code>, <code>serverName</code>,
035: * <code>serverPort</code> and <code>stream</code>
036: * properties <b>MUST</b> be set. The <code>contentLength</code>
037: * and <code>contentType</code> properties are also generally set.
038: * <li>For HttpRequests, the <code>method</code>, <code>queryString</code>,
039: * <code>requestedSessionCookie</code>,
040: * <code>requestedSessionId</code>, <code>requestedSessionURL</code>,
041: * <code>requestURI</code>, and <code>secure</code> properties
042: * <b>MUST</b> be set. In addition, the various <code>addXxx</code>
043: * methods must be called to record the presence of cookies, headers,
044: * and locales in the original request.
045: * <li>For all Responses, the <code>connector</code>, <code>request</code>,
046: * and <code>stream</code> properties <b>MUST</b> be set.
047: * <li>No additional headers must be set by the Connector for
048: * HttpResponses.
049: * </ul>
050: * <li>Identify an appropriate Container to use for processing this request.
051: * For a stand alone Catalina installation, this will probably be a
052: * (singleton) Engine implementation. For a Connector attaching Catalina
053: * to a web server such as Apache, this step could take advantage of
054: * parsing already performed within the web server to identify the
055: * Context, and perhaps even the Wrapper, to utilize in satisfying this
056: * Request.
057: * <li>Call the <code>invoke()</code> method of the selected Container,
058: * passing the initialized Request and Response instances as arguments.
059: * <li>Return any response created by the Container to the client, or
060: * return an appropriate error message if an exception of any type
061: * was thrown.
062: * <li>If utilizing a pool of Request and Response objects, recycle the pair
063: * of instances that was just used.
064: * </ul>
065: * It is expected that the implementation details of various Connectors will
066: * vary widely, so the logic above should considered typical rather than
067: * normative.
068: *
069: * @author Craig R. McClanahan
070: * @version $Revision: 1.3 $ $Date: 2004/02/27 14:58:38 $
071: */
072:
073: public interface Connector {
074:
075: // ------------------------------------------------------------- Properties
076:
077: /**
078: * Return the Container used for processing requests received by this
079: * Connector.
080: */
081: public Container getContainer();
082:
083: /**
084: * Set the Container used for processing requests received by this
085: * Connector.
086: *
087: * @param container The new Container to use
088: */
089: public void setContainer(Container container);
090:
091: /**
092: * Return the "enable DNS lookups" flag.
093: */
094: public boolean getEnableLookups();
095:
096: /**
097: * Set the "enable DNS lookups" flag.
098: *
099: * @param enableLookups The new "enable DNS lookups" flag value
100: */
101: public void setEnableLookups(boolean enableLookups);
102:
103: /**
104: * Return the server socket factory used by this Container.
105: */
106: public ServerSocketFactory getFactory();
107:
108: /**
109: * Set the server socket factory used by this Container.
110: *
111: * @param factory The new server socket factory
112: */
113: public void setFactory(ServerSocketFactory factory);
114:
115: /**
116: * Return descriptive information about this Connector implementation.
117: */
118: public String getInfo();
119:
120: /**
121: * Return the port number to which a request should be redirected if
122: * it comes in on a non-SSL port and is subject to a security constraint
123: * with a transport guarantee that requires SSL.
124: */
125: public int getRedirectPort();
126:
127: /**
128: * Set the redirect port number.
129: *
130: * @param redirectPort The redirect port number (non-SSL to SSL)
131: */
132: public void setRedirectPort(int redirectPort);
133:
134: /**
135: * Return the scheme that will be assigned to requests received
136: * through this connector. Default value is "http".
137: */
138: public String getScheme();
139:
140: /**
141: * Set the scheme that will be assigned to requests received through
142: * this connector.
143: *
144: * @param scheme The new scheme
145: */
146: public void setScheme(String scheme);
147:
148: /**
149: * Return the secure connection flag that will be assigned to requests
150: * received through this connector. Default value is "false".
151: */
152: public boolean getSecure();
153:
154: /**
155: * Set the secure connection flag that will be assigned to requests
156: * received through this connector.
157: *
158: * @param secure The new secure connection flag
159: */
160: public void setSecure(boolean secure);
161:
162: /**
163: * Return the <code>Service</code> with which we are associated (if any).
164: */
165: public Service getService();
166:
167: /**
168: * Set the <code>Service</code> with which we are associated (if any).
169: *
170: * @param service The service that owns this Engine
171: */
172: public void setService(Service service);
173:
174: // --------------------------------------------------------- Public Methods
175:
176: /**
177: * Create (or allocate) and return a Request object suitable for
178: * specifying the contents of a Request to the responsible Container.
179: */
180: public Request createRequest();
181:
182: /**
183: * Create (or allocate) and return a Response object suitable for
184: * receiving the contents of a Response from the responsible Container.
185: */
186: public Response createResponse();
187:
188: /**
189: * Invoke a pre-startup initialization. This is used to allow connectors
190: * to bind to restricted ports under Unix operating environments.
191: *
192: * @exception LifecycleException If this server was already initialized.
193: */
194: public void initialize() throws LifecycleException;
195:
196: /**
197: * Pause the connector.
198: */
199: public void pause() throws LifecycleException;
200:
201: /**
202: * Pause the connector.
203: */
204: public void resume() throws LifecycleException;
205:
206: }
|