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: 155418 $ 4 * $Date: 2005-02-26 08:01:52 -0500 (Sat, 26 Feb 2005) $ 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 * @author Oleg Kalnichevski 41 */ 42 public interface HttpRequestHandler { 43 /*** 44 * The request handler is asked to process this request. 45 * 46 * If it is not capable/interested in processing it, this call should 47 * be simply ignored. 48 * 49 * Any modification of the output stream (via <code>conn.getWriter()</code>) 50 * by this request handler will stop the execution chain and return the output 51 * to the client. 52 * 53 * The handler may also rewrite the request parameters (this is useful in 54 * {@link HttpRequestHandlerChain} structures). 55 * 56 * @param conn The Connection object to which this request belongs to. 57 * @param request The request object. 58 * @return true if this handler handled the request and no other handlers in the 59 * chain should be called, false otherwise. 60 * @throws IOException 61 */ 62 public boolean processRequest( 63 final SimpleHttpServerConnection conn, 64 final SimpleRequest request) throws IOException; 65 }