001/*
002 * ====================================================================
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *   http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing,
014 * software distributed under the License is distributed on an
015 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
016 * KIND, either express or implied.  See the License for the
017 * specific language governing permissions and limitations
018 * under the License.
019 * ====================================================================
020 *
021 * This software consists of voluntary contributions made by many
022 * individuals on behalf of the Apache Software Foundation.  For more
023 * information on the Apache Software Foundation, please see
024 * <http://www.apache.org/>.
025 *
026 */
027
028package org.apache.http.conn;
029
030import java.io.IOException;
031import java.net.InetSocketAddress;
032
033import org.apache.http.HttpHost;
034import org.apache.http.config.SocketConfig;
035import org.apache.http.protocol.HttpContext;
036
037/**
038 * Connection operator that performs connection connect and upgrade operations. Usually, components
039 * participating in these operations are registry of {@link org.apache.http.conn.socket.ConnectionSocketFactory},
040 * {@link SchemePortResolver} and {@link DnsResolver}. In general, HTTP client user should not
041 * provide implementations of this interface, as HttpClient will use the default one that covers
042 * most of the cases needed for majority of users.
043 *
044 * @since 4.4
045 */
046public interface HttpClientConnectionOperator {
047
048    void connect(
049            ManagedHttpClientConnection conn,
050            HttpHost host,
051            InetSocketAddress localAddress,
052            int connectTimeout,
053            SocketConfig socketConfig,
054            HttpContext context) throws IOException;
055
056    void upgrade(
057            ManagedHttpClientConnection conn,
058            HttpHost host,
059            HttpContext context) throws IOException;
060
061}