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: 155418 $
4 * $Date: 2005-02-26 08:01:52 -0500 (Sat, 26 Feb 2005) $
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.commons.httpclient.protocol;
31
32 import java.io.IOException;
33 import java.net.Socket;
34 import java.net.UnknownHostException;
35
36 /***
37 * A ProtocolSocketFactory that is secure.
38 *
39 * @see org.apache.commons.httpclient.protocol.ProtocolSocketFactory
40 *
41 * @author Michael Becke
42 * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
43 * @since 2.0
44 */
45 public interface SecureProtocolSocketFactory extends ProtocolSocketFactory {
46
47 /***
48 * Returns a socket connected to the given host that is layered over an
49 * existing socket. Used primarily for creating secure sockets through
50 * proxies.
51 *
52 * @param socket the existing socket
53 * @param host the host name/IP
54 * @param port the port on the host
55 * @param autoClose a flag for closing the underling socket when the created
56 * socket is closed
57 *
58 * @return Socket a new socket
59 *
60 * @throws IOException if an I/O error occurs while creating the socket
61 * @throws UnknownHostException if the IP address of the host cannot be
62 * determined
63 */
64 Socket createSocket(
65 Socket socket,
66 String host,
67 int port,
68 boolean autoClose
69 ) throws IOException, UnknownHostException;
70
71 }