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.client5.http.HttpRoute;
32 import org.apache.hc.client5.http.protocol.HttpClientContext;
33 import org.apache.hc.core5.annotation.Contract;
34 import org.apache.hc.core5.annotation.ThreadingBehavior;
35 import org.apache.hc.core5.concurrent.CancellableDependency;
36 import org.apache.hc.core5.http.HttpException;
37 import org.apache.hc.core5.http.HttpRequest;
38 import org.apache.hc.core5.http.nio.AsyncEntityProducer;
39 import org.apache.hc.core5.util.Args;
40
41 /**
42 * Represents a single element in the client side asynchronous request execution chain.
43 *
44 * @since 5.0
45 */
46 @Contract(threading = ThreadingBehavior.STATELESS)
47 public interface AsyncExecChain {
48
49 /**
50 * Request execution scope that includes the unique message exchange ID,
51 * the connection route, the original request message, the execution
52 * context and the internal execution runtime.
53 */
54 final class Scope {
55
56 public final String exchangeId;
57 public final HttpRoute route;
58 public final HttpRequest originalRequest;
59 public final CancellableDependency cancellableDependency;
60 public final HttpClientContext clientContext;
61 public final AsyncExecRuntime execRuntime;
62
63 public Scope(
64 final String exchangeId,
65 final HttpRoute route,
66 final HttpRequest originalRequest,
67 final CancellableDependency cancellableDependency,
68 final HttpClientContext clientContext,
69 final AsyncExecRuntime execRuntime) {
70 this.exchangeId = Args.notBlank(exchangeId, "Exchange id");
71 this.route = Args.notNull(route, "Route");
72 this.originalRequest = Args.notNull(originalRequest, "Original request");
73 this.cancellableDependency = Args.notNull(cancellableDependency, "Dependency");
74 this.clientContext = clientContext != null ? clientContext : HttpClientContext.create();
75 this.execRuntime = Args.notNull(execRuntime, "Exec runtime");
76 }
77
78 }
79
80 /**
81 * Proceeds to the next element in the request execution chain.
82 *
83 * @param request the actual request.
84 * @param entityProducer the request entity producer or {@code null} if the request
85 * does not enclose an entity.
86 * @param scope the execution scope .
87 * @param asyncExecCallback the execution callback.
88 */
89 void proceed(
90 HttpRequest request,
91 AsyncEntityProducer entityProducer,
92 Scope scope,
93 AsyncExecCallback asyncExecCallback) throws HttpException, IOException;
94
95 }