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.HttpException; 35 import org.apache.hc.core5.http.protocol.HttpContext; 36 37 /** 38 * HttpFilterHandler represents a routine for handling all incoming requests 39 * in the server side request processing chain. 40 * 41 * @since 5.0 42 */ 43 @Contract(threading = ThreadingBehavior.STATELESS) 44 public interface HttpFilterHandler { 45 46 /** 47 * Processes the incoming HTTP request and if processing has been completed 48 * submits a final response to the client. The handler must not use 49 * the response trigger after passing control to the next filter with the 50 * {@link HttpFilterChain#proceed(ClassicHttpRequest, HttpFilterChain.ResponseTrigger, HttpContext)} 51 * method. 52 * 53 * @param request the actual request. 54 * @param responseTrigger the response trigger. 55 * @param context the actual execution context. 56 * @param chain the next element in the request processing chain. 57 */ 58 void handle( 59 ClassicHttpRequest request, 60 HttpFilterChain.ResponseTrigger responseTrigger, 61 HttpContext context, 62 HttpFilterChain chain) throws HttpException, IOException; 63 64 }