View Javadoc

1   /*
2    * ====================================================================
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *   http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing,
14   * software distributed under the License is distributed on an
15   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16   * KIND, either express or implied.  See the License for the
17   * specific language governing permissions and limitations
18   * under the License.
19   * ====================================================================
20   *
21   * This software consists of voluntary contributions made by many
22   * individuals on behalf of the Apache Software Foundation.  For more
23   * information on the Apache Software Foundation, please see
24   * <http://www.apache.org/>.
25   *
26   */
27  
28  package org.apache.http.protocol;
29  
30  import java.io.IOException;
31  
32  import org.apache.http.HttpException;
33  import org.apache.http.HttpRequest;
34  import org.apache.http.HttpResponse;
35  
36  /**
37   * HttpRequestHandler represents a routine for processing of a specific group
38   * of HTTP requests. Protocol handlers are designed to take care of protocol
39   * specific aspects, whereas individual request handlers are expected to take
40   * care of application specific HTTP processing. The main purpose of a request
41   * handler is to generate a response object with a content entity to be sent
42   * back to the client in response to the given request
43   *
44   * @since 4.0
45   */
46  public interface HttpRequestHandler {
47  
48      /**
49       * Handles the request and produces a response to be sent back to
50       * the client.
51       *
52       * @param request the HTTP request.
53       * @param response the HTTP response.
54       * @param context the HTTP execution context.
55       * @throws IOException in case of an I/O error.
56       * @throws HttpException in case of HTTP protocol violation or a processing
57       *   problem.
58       */
59      void handle(HttpRequest request, HttpResponse response, HttpContext context)
60              throws HttpException, IOException;
61  
62  }