1 /*
2 * $Header: /home/cvs/jakarta-commons/httpclient/src/test/org/apache/commons/httpclient/server/HttpRequestHandler.java,v 1.1.2.3 2004/02/22 18:21:18 olegk Exp $
3 * $Revision: 1.1.2.3 $
4 * $Date: 2004/02/22 18:21:18 $
5 *
6 * ====================================================================
7 *
8 * Copyright 1999-2004 The Apache Software Foundation
9 *
10 * Licensed under the Apache License, Version 2.0 (the "License");
11 * you may not use this file except in compliance with the License.
12 * You may obtain a copy of the License at
13 *
14 * http://www.apache.org/licenses/LICENSE-2.0
15 *
16 * Unless required by applicable law or agreed to in writing, software
17 * distributed under the License is distributed on an "AS IS" BASIS,
18 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19 * See the License for the specific language governing permissions and
20 * limitations under the License.
21 * ====================================================================
22 *
23 * This software consists of voluntary contributions made by many
24 * individuals on behalf of the Apache Software Foundation. For more
25 * information on the Apache Software Foundation, please see
26 * <http://www.apache.org/>.
27 *
28 * [Additional notices, if required by prior licensing conditions]
29 *
30 */
31
32 package org.apache.commons.httpclient.server;
33
34 import java.io.IOException;
35
36 /***
37 * Defines an HTTP request handler for the SimpleHttpServer
38 *
39 * @author Christian Kohlschuetter
40 */
41 public interface HttpRequestHandler {
42 /***
43 * The request handler is asked to process this request.
44 *
45 * If it is not capable/interested in processing it, this call should
46 * be simply ignored.
47 *
48 * Any modification of the output stream (via <code>conn.getWriter()</code>)
49 * by this request handler will stop the execution chain and return the output
50 * to the client.
51 *
52 * The handler may also rewrite the request parameters (this is useful in
53 * {@link HttpRequestHandlerChain} structures).
54 *
55 * @param conn The Connection object to which this request belongs to.
56 * @return true if this handler handled the request and no other handlers in the
57 * chain should be called, false otherwise.
58 * @throws IOException
59 */
60 public boolean processRequest(SimpleHttpServerConnection conn) throws IOException;
61 }