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.hc.core5.http.io;
29
30 import java.io.IOException;
31
32 import org.apache.hc.core5.http.ClassicHttpRequest;
33 import org.apache.hc.core5.http.ClassicHttpResponse;
34 import org.apache.hc.core5.http.HttpException;
35 import org.apache.hc.core5.http.protocol.HttpContext;
36
37 /**
38 * HttpRequestHandler represents a routine for processing of a specific group
39 * of HTTP requests. Protocol handlers are designed to take care of protocol
40 * specific aspects, whereas individual request handlers are expected to take
41 * care of application specific HTTP processing. The main purpose of a request
42 * handler is to generate a response object with a content entity to be sent
43 * back to the client in response to the given request
44 *
45 * @since 4.0
46 */
47 public interface HttpRequestHandler {
48
49 /**
50 * Handles the request and produces a response to be sent back to
51 * the client.
52 *
53 * @param request the HTTP request.
54 * @param response the HTTP response.
55 * @param context the HTTP execution context.
56 * @throws IOException in case of an I/O error.
57 * @throws HttpException in case of HTTP protocol violation or a processing
58 * problem.
59 */
60 void handle(ClassicHttpRequest request, ClassicHttpResponse response, HttpContext context)
61 throws HttpException, IOException;
62
63 }