001/*
002 * ====================================================================
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *   http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing,
014 * software distributed under the License is distributed on an
015 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
016 * KIND, either express or implied.  See the License for the
017 * specific language governing permissions and limitations
018 * under the License.
019 * ====================================================================
020 *
021 * This software consists of voluntary contributions made by many
022 * individuals on behalf of the Apache Software Foundation.  For more
023 * information on the Apache Software Foundation, please see
024 * <http://www.apache.org/>.
025 *
026 */
027
028package org.apache.http.protocol;
029
030import java.io.IOException;
031
032import org.apache.http.HttpException;
033import org.apache.http.HttpRequest;
034import org.apache.http.HttpResponse;
035
036/**
037 * HttpRequestHandler represents a routine for processing of a specific group
038 * of HTTP requests. Protocol handlers are designed to take care of protocol
039 * specific aspects, whereas individual request handlers are expected to take
040 * care of application specific HTTP processing. The main purpose of a request
041 * handler is to generate a response object with a content entity to be sent
042 * back to the client in response to the given request
043 *
044 * @since 4.0
045 */
046public interface HttpRequestHandler {
047
048    /**
049     * Handles the request and produces a response to be sent back to
050     * the client.
051     *
052     * @param request the HTTP request.
053     * @param response the HTTP response.
054     * @param context the HTTP execution context.
055     * @throws IOException in case of an I/O error.
056     * @throws HttpException in case of HTTP protocol violation or a processing
057     *   problem.
058     */
059    void handle(HttpRequest request, HttpResponse response, HttpContext context)
060            throws HttpException, IOException;
061
062}