← Back to branch summary

~ubuntu-branches/ubuntu/lucid/commons-httpclient/lucid

« back to all changes in this revision

Viewing changes to src/java/org/apache/commons/httpclient/protocol/SecureProtocolSocketFactory.java

  • Committer: Bazaar Package Importer
  • Author(s): Barry Hawkins
  • Date: 2005-11-25 13:12:23 UTC
  • Revision ID: james.westby@ubuntu.com-20051125131223-2g7eyo21pqgrohpo
Tags: upstream-2.0.2
Import upstream version 2.0.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/java/org/apache/commons/httpclient/protocol/SecureProtocolSocketFactory.java
 
1
/*
 
2
 * $Header: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/protocol/SecureProtocolSocketFactory.java,v 1.4.2.1 2004/02/22 18:21:16 olegk Exp $
 
3
 * $Revision: 1.4.2.1 $
 
4
 * $Date: 2004/02/22 18:21:16 $
 
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
 * [Additional notices, if required by prior licensing conditions]
 
29
 *
 
30
 */
 
31
 
 
32
package org.apache.commons.httpclient.protocol;
 
33
 
 
34
import java.io.IOException;
 
35
import java.net.Socket;
 
36
import java.net.UnknownHostException;
 
37
 
 
38
/**
 
39
 * A ProtocolSocketFactory that is secure.
 
40
 * 
 
41
 * @see org.apache.commons.httpclient.protocol.ProtocolSocketFactory
 
42
 * 
 
43
 * @author Michael Becke
 
44
 * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
 
45
 * @since 2.0
 
46
 */
 
47
public interface SecureProtocolSocketFactory extends 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(
 
67
        Socket socket, 
 
68
        String host, 
 
69
        int port, 
 
70
        boolean autoClose
 
71
    ) throws IOException, UnknownHostException;              
 
72
 
 
73
}