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.io; 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.ClassicHttpRequest; 34 import org.apache.hc.core5.http.ClassicHttpResponse; 35 import org.apache.hc.core5.http.HttpException; 36 import org.apache.hc.core5.http.protocol.HttpContext; 37 38 /** 39 * HttpFilterChain represents a single element in the server side request processing chain. 40 * 41 * @since 5.0 42 */ 43 @Contract(threading = ThreadingBehavior.STATELESS) 44 public interface HttpFilterChain { 45 46 /** 47 * Response trigger that can be used to generate the final HTTP response 48 * and terminate HTTP request processing. 49 */ 50 interface ResponseTrigger { 51 52 /** 53 * Sends an intermediate informational HTTP response to the client. 54 * 55 * @param response an intermediate (1xx) HTTP response. 56 */ 57 void sendInformation(ClassicHttpResponse response) throws HttpException, IOException; 58 59 /** 60 * Sends a final HTTP response to the client. 61 * 62 * @param response a final (non 1xx) HTTP response. 63 */ 64 void submitResponse(ClassicHttpResponse response) throws HttpException, IOException; 65 66 } 67 68 /** 69 * Proceeds to the next element in the request processing chain. 70 * 71 * @param request the actual request. 72 * @param responseTrigger the response trigger. 73 * @param context the actual execution context. 74 */ 75 void proceed( 76 ClassicHttpRequest request, 77 ResponseTrigger responseTrigger, 78 HttpContext context) throws HttpException, IOException; 79 80 }