View Javadoc
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  
28  package org.apache.hc.client5.http.classic;
29  
30  import java.io.IOException;
31  
32  import org.apache.hc.client5.http.HttpRoute;
33  import org.apache.hc.client5.http.protocol.HttpClientContext;
34  import org.apache.hc.core5.annotation.Contract;
35  import org.apache.hc.core5.annotation.ThreadingBehavior;
36  import org.apache.hc.core5.http.ClassicHttpRequest;
37  import org.apache.hc.core5.http.ClassicHttpResponse;
38  import org.apache.hc.core5.http.HttpException;
39  import org.apache.hc.core5.util.Args;
40  
41  /**
42   * Represents a single element in the client side classic request execution chain.
43   *
44   * @since 5.0
45   */
46  @Contract(threading = ThreadingBehavior.STATELESS)
47  public interface ExecChain {
48  
49      final class Scope {
50  
51          public final String exchangeId;
52          public final HttpRoute route;
53          public final ClassicHttpRequest originalRequest;
54          public final ExecRuntime execRuntime;
55          public final HttpClientContext clientContext;
56  
57          public Scope(final String exchangeId, final HttpRoute route, final ClassicHttpRequest originalRequest, final ExecRuntime execRuntime, final HttpClientContext clientContext) {
58              this.exchangeId = Args.notNull(exchangeId, "Exchange id");
59              this.route = Args.notNull(route, "Route");
60              this.originalRequest = Args.notNull(originalRequest, "Original request");
61              this.execRuntime = Args.notNull(execRuntime, "Exec runtime");
62              this.clientContext = clientContext != null ? clientContext : HttpClientContext.create();
63          }
64  
65      }
66  
67      ClassicHttpResponse proceed(
68              ClassicHttpRequest request,
69              Scope scope) throws IOException, HttpException;
70  
71  }