1   /*
    2    * $HeadURL: https://svn.apache.org/repos/asf/jakarta/httpcomponents/httpcore/tags/4.0-alpha2/src/java/org/apache/http/io/SecureSocketFactory.java $
    3    * $Revision: 376961 $
    4    * $Date: 2006-02-11 11:32:50 +0100 (Sat, 11 Feb 2006) $
    5    *
    6    * ====================================================================
    7    *
    8    *  Copyright 2002-2004 The Apache Software Foundation
    9    *
   10    *  Licensed under the Apache License, Version 2.0 (the "License");
   11    *  you may not use this file except in compliance with the License.
   12    *  You may obtain a copy of the License at
   13    *
   14    *      http://www.apache.org/licenses/LICENSE-2.0
   15    *
   16    *  Unless required by applicable law or agreed to in writing, software
   17    *  distributed under the License is distributed on an "AS IS" BASIS,
   18    *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   19    *  See the License for the specific language governing permissions and
   20    *  limitations under the License.
   21    * ====================================================================
   22    *
   23    * This software consists of voluntary contributions made by many
   24    * individuals on behalf of the Apache Software Foundation.  For more
   25    * information on the Apache Software Foundation, please see
   26    * <http://www.apache.org/>.
   27    *
   28    */
   29   
   30   package org.apache.http.io;
   31   
   32   import java.io.IOException;
   33   import java.net.Socket;
   34   import java.net.UnknownHostException;
   35   
   36   /**
   37    * A {@link SocketFactory SocketFactory} for secure sockets (SSL/TLS).
   38    * See there for things to consider when implementing a socket factory.
   39    * 
   40    * @author Michael Becke
   41    * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
   42    * @since 2.0
   43    */
   44   public interface SecureSocketFactory extends SocketFactory {
   45   
   46       /**
   47        * Returns a socket connected to the given host that is layered over an
   48        * existing socket.  Used primarily for creating secure sockets through
   49        * proxies.
   50        * 
   51        * @param socket the existing socket 
   52        * @param host the host name/IP
   53        * @param port the port on the host
   54        * @param autoClose a flag for closing the underling socket when the created
   55        * socket is closed
   56        * 
   57        * @return Socket a new socket
   58        * 
   59        * @throws IOException if an I/O error occurs while creating the socket
   60        * @throws UnknownHostException if the IP address of the host cannot be
   61        * determined
   62        */
   63       Socket createSocket(
   64           Socket socket, 
   65           String host, 
   66           int port, 
   67           boolean autoClose
   68       ) throws IOException, UnknownHostException;              
   69   
   70   }