01: /*
02: * $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 $
03: * $Revision: 480424 $
04: * $Date: 2006-11-29 06:56:49 +0100 (Wed, 29 Nov 2006) $
05: *
06: * ====================================================================
07: *
08: * Licensed to the Apache Software Foundation (ASF) under one or more
09: * 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
47: ProtocolSocketFactory {
48:
49: /**
50: * Returns a socket connected to the given host that is layered over an
51: * existing socket. Used primarily for creating secure sockets through
52: * proxies.
53: *
54: * @param socket the existing socket
55: * @param host the host name/IP
56: * @param port the port on the host
57: * @param autoClose a flag for closing the underling socket when the created
58: * socket is closed
59: *
60: * @return Socket a new socket
61: *
62: * @throws IOException if an I/O error occurs while creating the socket
63: * @throws UnknownHostException if the IP address of the host cannot be
64: * determined
65: */
66: Socket createSocket(Socket socket, String host, int port,
67: boolean autoClose) throws IOException, UnknownHostException;
68:
69: }
|