Home | History | Annotate | Download | only in scheme 
      1 /*
      2  * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/conn/scheme/LayeredSocketFactory.java $
      3  * $Revision: 645850 $
      4  * $Date: 2008-04-08 04:08:52 -0700 (Tue, 08 Apr 2008) $
      5  *
      6  * ====================================================================
      7  * Licensed to the Apache Software Foundation (ASF) under one
      8  * or more contributor license agreements.  See the NOTICE file
      9  * distributed with this work for additional information
     10  * regarding copyright ownership.  The ASF licenses this file
     11  * to you under the Apache License, Version 2.0 (the
     12  * "License"); you may not use this file except in compliance
     13  * with the License.  You may obtain a copy of the License at
     14  *
     15  *   http://www.apache.org/licenses/LICENSE-2.0
     16  *
     17  * Unless required by applicable law or agreed to in writing,
     18  * software distributed under the License is distributed on an
     19  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     20  * KIND, either express or implied.  See the License for the
     21  * specific language governing permissions and limitations
     22  * under the License.
     23  * ====================================================================
     24  *
     25  * This software consists of voluntary contributions made by many
     26  * individuals on behalf of the Apache Software Foundation.  For more
     27  * information on the Apache Software Foundation, please see
     28  * <http://www.apache.org/>.
     29  *
     30  */
     31 
     32 package org.apache.http.conn.scheme;
     33 
     34 import java.io.IOException;
     35 import java.net.Socket;
     36 import java.net.UnknownHostException;
     37 
     38 /**
     39  * A {@link SocketFactory SocketFactory} for layered sockets (SSL/TLS).
     40  * See there for things to consider when implementing a socket factory.
     41  *
     42  * @author Michael Becke
     43  * @author <a href="mailto:mbowler (at) GargoyleSoftware.com">Mike Bowler</a>
     44  * @since 4.0
     45  *
     46  * @deprecated Please use {@link java.net.URL#openConnection} instead.
     47  *     Please visit <a href="http://android-developers.blogspot.com/2011/09/androids-http-clients.html">this webpage</a>
     48  *     for further details.
     49  */
     50 @Deprecated
     51 public interface LayeredSocketFactory extends SocketFactory {
     52 
     53     /**
     54      * Returns a socket connected to the given host that is layered over an
     55      * existing socket.  Used primarily for creating secure sockets through
     56      * proxies.
     57      *
     58      * @param socket the existing socket
     59      * @param host the host name/IP
     60      * @param port the port on the host
     61      * @param autoClose a flag for closing the underling socket when the created
     62      * socket is closed
     63      *
     64      * @return Socket a new socket
     65      *
     66      * @throws IOException if an I/O error occurs while creating the socket
     67      * @throws UnknownHostException if the IP address of the host cannot be
     68      * determined
     69      */
     70     Socket createSocket(
     71         Socket socket,
     72         String host,
     73         int port,
     74         boolean autoClose
     75     ) throws IOException, UnknownHostException;
     76 
     77 }
     78