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