/*
 * ====================================================================
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 *
 */

package org.apache.hc.client5.http.socket;

import java.io.IOException;
import java.net.Socket;

import org.apache.hc.core5.annotation.Contract;
import org.apache.hc.core5.annotation.ThreadingBehavior;
import org.apache.hc.core5.http.protocol.HttpContext;

/**
 * Extended {@link ConnectionSocketFactory} interface for layered sockets such as SSL/TLS.
 *
 * @since 4.3
 */
@Contract(threading = ThreadingBehavior.STATELESS)
public interface LayeredConnectionSocketFactory extends ConnectionSocketFactory {

    /**
     * Returns a socket connected to the given host that is layered over an
     * existing socket.  Used primarily for creating secure sockets through
     * proxies.
     *
     * @param socket the existing socket
     * @param target the name of the target host.
     * @param port the port to connect to on the target host.
     * @param context the actual HTTP context.
     *
     * @return Socket a new socket
     *
     * @throws IOException if an I/O error occurs while creating the socket
     */
    Socket createLayeredSocket(
        Socket socket,
        String target,
        int port,
        HttpContext context) throws IOException;

    /**
     * Returns a socket connected to the given host that is layered over an
     * existing socket.  Used primarily for creating secure sockets through
     * proxies.
     *
     * @param socket the existing socket
     * @param target the name of the target host.
     * @param port the port to connect to on the target host.
     * @param context the actual HTTP context.
     * @param attachment connect request attachment.
     *
     * @return Socket a new socket
     *
     * @throws IOException if an I/O error occurs while creating the socket
     *
     * @since 5.2
     */
    default Socket createLayeredSocket(
            Socket socket,
            String target,
            int port,
            Object attachment,
            HttpContext context) throws IOException {
        return createLayeredSocket(socket, target, port, context);
    }

}
