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 package org.apache.hc.core5.http.nio;
28
29 import java.io.IOException;
30
31 import org.apache.hc.core5.annotation.Contract;
32 import org.apache.hc.core5.annotation.ThreadingBehavior;
33 import org.apache.hc.core5.http.EntityDetails;
34 import org.apache.hc.core5.http.HttpException;
35 import org.apache.hc.core5.http.HttpRequest;
36 import org.apache.hc.core5.http.protocol.HttpContext;
37
38 /**
39 * AsyncFilterHandler represents a routine for handling all incoming requests
40 * in the server side request processing chain.
41 *
42 * @since 5.0
43 */
44 @Contract(threading = ThreadingBehavior.STATELESS)
45 public interface AsyncFilterHandler {
46
47 /**
48 * Processes the incoming HTTP request and if processing has been completed
49 * submits a final response to the client. The handler can choose to send
50 * response messages immediately inside the call or asynchronously at some later point.
51 * The handler must not use the response trigger after passing control to the next filter
52 * with the
53 * {@link AsyncFilterChain#proceed(HttpRequest, EntityDetails, HttpContext, AsyncFilterChain.ResponseTrigger)}
54 * method.
55 *
56 * @param request the actual request head.
57 * @param entityDetails the request entity details or {@code null} if the request
58 * does not enclose an entity.
59 * @param context the actual execution context.
60 * @param responseTrigger the response trigger.
61 * @param chain the next element in the request processing chain.
62 * @return the data consumer to be used to process incoming request data. It is
63 * expected to be {@code null} if entityDetails parameter is {@code null}.
64 */
65 AsyncDataConsumer handle(
66 HttpRequest request,
67 EntityDetails entityDetails,
68 HttpContext context,
69 AsyncFilterChain.ResponseTrigger responseTrigger,
70 AsyncFilterChain chain) throws HttpException, IOException;
71
72 }