michael@0: /*
michael@0:  * ====================================================================
michael@0:  * Licensed to the Apache Software Foundation (ASF) under one
michael@0:  * or more contributor license agreements.  See the NOTICE file
michael@0:  * distributed with this work for additional information
michael@0:  * regarding copyright ownership.  The ASF licenses this file
michael@0:  * to you under the Apache License, Version 2.0 (the
michael@0:  * "License"); you may not use this file except in compliance
michael@0:  * with the License.  You may obtain a copy of the License at
michael@0:  *
michael@0:  *   http://www.apache.org/licenses/LICENSE-2.0
michael@0:  *
michael@0:  * Unless required by applicable law or agreed to in writing,
michael@0:  * software distributed under the License is distributed on an
michael@0:  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
michael@0:  * KIND, either express or implied.  See the License for the
michael@0:  * specific language governing permissions and limitations
michael@0:  * under the License.
michael@0:  * ====================================================================
michael@0:  *
michael@0:  * This software consists of voluntary contributions made by many
michael@0:  * individuals on behalf of the Apache Software Foundation.  For more
michael@0:  * information on the Apache Software Foundation, please see
michael@0:  * <http://www.apache.org/>.
michael@0:  *
michael@0:  */
michael@0: 
michael@0: package ch.boye.httpclientandroidlib.protocol;
michael@0: 
michael@0: import java.io.IOException;
michael@0: 
michael@0: import ch.boye.httpclientandroidlib.HttpException;
michael@0: import ch.boye.httpclientandroidlib.HttpRequest;
michael@0: import ch.boye.httpclientandroidlib.HttpResponse;
michael@0: 
michael@0: /**
michael@0:  * HttpRequestHandler represents a routine for processing of a specific group
michael@0:  * of HTTP requests. Protocol handlers are designed to take care of protocol
michael@0:  * specific aspects, whereas individual request handlers are expected to take
michael@0:  * care of application specific HTTP processing. The main purpose of a request
michael@0:  * handler is to generate a response object with a content entity to be sent
michael@0:  * back to the client in response to the given request
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: public interface HttpRequestHandler {
michael@0: 
michael@0:     /**
michael@0:      * Handles the request and produces a response to be sent back to
michael@0:      * the client.
michael@0:      *
michael@0:      * @param request the HTTP request.
michael@0:      * @param response the HTTP response.
michael@0:      * @param context the HTTP execution context.
michael@0:      * @throws IOException in case of an I/O error.
michael@0:      * @throws HttpException in case of HTTP protocol violation or a processing
michael@0:      *   problem.
michael@0:      */
michael@0:     void handle(HttpRequest request, HttpResponse response, HttpContext context)
michael@0:             throws HttpException, IOException;
michael@0: 
michael@0: }