SecureProtocolSocketFactory xref

View Javadoc

    1   /*
    2    * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//httpclient/src/java/org/apache/commons/httpclient/protocol/SecureProtocolSocketFactory.java,v 1.6 2004/04/18 23:51:38 jsdever Exp $
    3    * $Revision: 480424 $
    4    * $Date: 2006-11-29 06:56:49 +0100 (Wed, 29 Nov 2006) $
    5    *
    6    * ====================================================================
    7    *
    8    *  Licensed to the Apache Software Foundation (ASF) under one or more
    9    *  contributor license agreements.  See the NOTICE file distributed with
    10   *  this work for additional information regarding copyright ownership.
    11   *  The ASF licenses this file to You under the Apache License, Version 2.0
    12   *  (the "License"); you may not use this file except in compliance with
    13   *  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, software
    18   *  distributed under the License is distributed on an "AS IS" BASIS,
    19   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    20   *  See the License for the specific language governing permissions and
    21   *  limitations under the License.
    22   * ====================================================================
    23   *
    24   * This software consists of voluntary contributions made by many
    25   * individuals on behalf of the Apache Software Foundation.  For more
    26   * information on the Apache Software Foundation, please see
    27   * <http://www.apache.org/>.
    28   *
    29   */
    30
    31  package org.apache.commons.httpclient.protocol;
    32
    33  import java.io.IOException;
    34  import java.net.Socket;
    35  import java.net.UnknownHostException;
    36
    37  /**
    38   * A ProtocolSocketFactory that is secure.
    39   *
    40   * @see org.apache.commons.httpclient.protocol.ProtocolSocketFactory
    41   *
    42   * @author Michael Becke
    43   * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
    44   * @since 2.0
    45   */
    46  public interface SecureProtocolSocketFactory extends ProtocolSocketFactory {
    47
    48      /**
    49       * Returns a socket connected to the given host that is layered over an
    50       * existing socket.  Used primarily for creating secure sockets through
    51       * proxies.
    52       *
    53       * @param socket the existing socket
    54       * @param host the host name/IP
    55       * @param port the port on the host
    56       * @param autoClose a flag for closing the underling socket when the created
    57       * socket is closed
    58       *
    59       * @return Socket a new socket
    60       *
    61       * @throws IOException if an I/O error occurs while creating the socket
    62       * @throws UnknownHostException if the IP address of the host cannot be
    63       * determined
    64       */
    65      Socket createSocket(
    66          Socket socket,
    67          String host,
    68          int port,
    69          boolean autoClose
    70      ) throws IOException, UnknownHostException;
    71
    72  }