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.HttpResponse; 37 import org.apache.hc.core5.http.protocol.HttpContext; 38 39 /** 40 * AsyncFilterChain represents a single element in the server side request processing chain. 41 * 42 * @since 5.0 43 */ 44 @Contract(threading = ThreadingBehavior.STATELESS) 45 public interface AsyncFilterChain { 46 47 /** 48 * Response trigger that can be used to generate the final HTTP response 49 * and terminate HTTP request processing. 50 */ 51 interface ResponseTrigger { 52 53 /** 54 * Sends an intermediate informational HTTP response to the client. 55 * 56 * @param response the intermediate (1xx) HTTP response. 57 */ 58 void sendInformation(HttpResponse response) throws HttpException, IOException; 59 60 /** 61 * Sends a final HTTP response to the client. 62 * 63 * @param response the final (non 1xx) HTTP response. 64 */ 65 void submitResponse(HttpResponse response, AsyncEntityProducer entityProducer) throws HttpException, IOException; 66 67 /** 68 * Pushes a request message head as a promise to deliver a response message. 69 * 70 * @param promise the request message header used as a promise. 71 * @param responseProducer the push response message producer. 72 */ 73 void pushPromise(HttpRequest promise, AsyncPushProducer responseProducer) throws HttpException, IOException; 74 75 } 76 77 /** 78 * Proceeds to the next element in the request processing chain. 79 * 80 * @param request the actual request. 81 * @param entityDetails the request entity details or {@code null} if the request 82 * does not enclose an entity. 83 * @param responseTrigger the response trigger. 84 * @param context the actual execution context. 85 */ 86 AsyncDataConsumer proceed( 87 HttpRequest request, 88 EntityDetails entityDetails, 89 HttpContext context, 90 ResponseTrigger responseTrigger) throws HttpException, IOException; 91 92 }