/*
    * $HeadURL: https://svn.apache.org/repos/asf/httpcomponents/oac.hc3x/trunk/src/java/org/apache/commons/httpclient/protocol/SSLProtocolSocketFactory.java $
    * $Revision: 1425331 $
    * $Date: 2012-12-22 18:29:41 +0000 (Sat, 22 Dec 2012) $
    *
    * ====================================================================
    *
    *  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.commons.httpclient.protocol;
  
  import java.io.IOException;
  import java.net.InetAddress;
  import java.net.Socket;
  import java.net.UnknownHostException;
  
  import javax.net.ssl.SSLSocketFactory;
  
  import org.apache.commons.httpclient.ConnectTimeoutException;
  import org.apache.commons.httpclient.params.HttpConnectionParams;
  
  /***
   * A SecureProtocolSocketFactory that uses JSSE to create sockets.
   * 
   * @author Michael Becke
   * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
   * 
   * @since 2.0
   */
  public class SSLProtocolSocketFactory implements SecureProtocolSocketFactory {
  
      /***
       * The factory singleton.
       */
      private static final SSLProtocolSocketFactory factory = new SSLProtocolSocketFactory();
      
      /***
       * Gets an singleton instance of the SSLProtocolSocketFactory.
       * @return a SSLProtocolSocketFactory
       */
      static SSLProtocolSocketFactory getSocketFactory() {
          return factory;
      }    
      
      /***
       * Constructor for SSLProtocolSocketFactory.
       */
      public SSLProtocolSocketFactory() {
          super();
      }
  
      /***
       * @see SecureProtocolSocketFactory#createSocket(java.lang.String,int,java.net.InetAddress,int)
       */
      public Socket createSocket(
          String host,
          int port,
          InetAddress clientHost,
          int clientPort)
          throws IOException, UnknownHostException {
          return SSLSocketFactory.getDefault().createSocket(
              host,
              port,
              clientHost,
              clientPort
          );
      }
  
      /***
       * Attempts to get a new socket connection to the given host within the given time limit.
       * <p>
       * This method employs several techniques to circumvent the limitations of older JREs that 
       * do not support connect timeout. When running in JRE 1.4 or above reflection is used to 
       * call Socket#connect(SocketAddress endpoint, int timeout) method. When executing in older 
       * JREs a controller thread is executed. The controller thread attempts to create a new socket
       * within the given limit of time. If socket constructor does not return until the timeout 
       * expires, the controller terminates and throws an {@link ConnectTimeoutException}
       * </p>
      *  
      * @param host the host name/IP
      * @param port the port on the host
      * @param localAddress the local host name/IP to bind the socket to
      * @param localPort the port on the local machine
      * @param params {@link HttpConnectionParams Http connection parameters}
      * 
      * @return Socket a new socket
      * 
      * @throws IOException if an I/O error occurs while creating the socket
      * @throws UnknownHostException if the IP address of the host cannot be
      * determined
      * 
      * @since 3.0
      */
     public Socket createSocket(
         final String host,
         final int port,
         final InetAddress localAddress,
         final int localPort,
         final HttpConnectionParams params
     ) throws IOException, UnknownHostException, ConnectTimeoutException {
         if (params == null) {
             throw new IllegalArgumentException("Parameters may not be null");
         }
         int timeout = params.getConnectionTimeout();
         if (timeout == 0) {
             return createSocket(host, port, localAddress, localPort);
         } else {
             // To be eventually deprecated when migrated to Java 1.4 or above
             Socket socket = ReflectionSocketFactory.createSocket(
                 "javax.net.ssl.SSLSocketFactory", host, port, localAddress, localPort, timeout);
             if (socket == null) {
                 socket = ControllerThreadSocketFactory.createSocket(
                     this, host, port, localAddress, localPort, timeout);
             }
             return socket;
         }
     }
 
     /***
      * @see SecureProtocolSocketFactory#createSocket(java.lang.String,int)
      */
     public Socket createSocket(String host, int port)
         throws IOException, UnknownHostException {
         return SSLSocketFactory.getDefault().createSocket(
             host,
             port
         );
     }
 
     /***
      * @see SecureProtocolSocketFactory#createSocket(java.net.Socket,java.lang.String,int,boolean)
      */
     public Socket createSocket(
         Socket socket,
         String host,
         int port,
         boolean autoClose)
         throws IOException, UnknownHostException {
         return ((SSLSocketFactory) SSLSocketFactory.getDefault()).createSocket(
             socket,
             host,
             port,
             autoClose
         );
     }
 
     /***
      * All instances of SSLProtocolSocketFactory are the same.
      */
     public boolean equals(Object obj) {
         return ((obj != null) && obj.getClass().equals(getClass()));
     }
 
     /***
      * All instances of SSLProtocolSocketFactory have the same hash code.
      */
     public int hashCode() {
         return getClass().hashCode();
     }    
     
 }