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.http.conn;
29  
30  import java.io.IOException;
31  import java.net.InetSocketAddress;
32  
33  import org.apache.http.HttpHost;
34  import org.apache.http.config.SocketConfig;
35  import org.apache.http.protocol.HttpContext;
36  
37  /**
38   * Connection operator that performs connection connect and upgrade operations. Usually, components
39   * participating in these operations are registry of {@link org.apache.http.conn.socket.ConnectionSocketFactory},
40   * {@link SchemePortResolver} and {@link DnsResolver}. In general, HTTP client user should not
41   * provide implementations of this interface, as HttpClient will use the default one that covers
42   * most of the cases needed for majority of users.
43   *
44   * @since 4.4
45   */
46  public interface HttpClientConnectionOperator {
47  
48      void connect(
49              ManagedHttpClientConnection conn,
50              HttpHost host,
51              InetSocketAddress localAddress,
52              int connectTimeout,
53              SocketConfig socketConfig,
54              HttpContext context) throws IOException;
55  
56      void upgrade(
57              ManagedHttpClientConnection conn,
58              HttpHost host,
59              HttpContext context) throws IOException;
60  
61  }