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.client5.http.async; 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.HttpException; 34 import org.apache.hc.core5.http.HttpRequest; 35 import org.apache.hc.core5.http.nio.AsyncEntityProducer; 36 37 /** 38 * Abstract request execution handler in an asynchronous client side request execution 39 * chain. Handlers can either be a decorator around another element that implements 40 * a cross cutting aspect or a self-contained executor capable of producing a response 41 * for the given request. 42 * 43 * @since 5.0 44 */ 45 @Contract(threading = ThreadingBehavior.STATELESS) 46 public interface AsyncExecChainHandler { 47 48 /** 49 * Executes the actual HTTP request. The handler can choose to return 50 * a response message immediately inside the call or asynchronously 51 * at some later point or delegate request execution to the next 52 * element in the execution chain. 53 * 54 * @param request the actual request. 55 * @param entityProducer the request entity producer or {@code null} if the request 56 * does not enclose an entity. 57 * @param scope the execution scope . 58 * @param chain the next element in the request execution chain. 59 * @param asyncExecCallback the execution callback. 60 */ 61 void execute( 62 HttpRequest request, 63 AsyncEntityProducer entityProducer, 64 AsyncExecChain.Scope scope, 65 AsyncExecChain chain, 66 AsyncExecCallback asyncExecCallback) throws HttpException, IOException; 67 68 }