1 /*
2 * $Header: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/protocol/ProtocolSocketFactory.java,v 1.5.2.1 2004/01/30 19:23:15 mbecke Exp $
3 * $Revision: 1.5.2.1 $
4 * $Date: 2004/01/30 19:23:15 $
5 *
6 * ====================================================================
7 *
8 * The Apache Software License, Version 1.1
9 *
10 * Copyright (c) 2002-2003 The Apache Software Foundation. All rights
11 * reserved.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
15 * are met:
16 *
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 *
20 * 2. Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in
22 * the documentation and/or other materials provided with the
23 * distribution.
24 *
25 * 3. The end-user documentation included with the redistribution, if
26 * any, must include the following acknowlegement:
27 * "This product includes software developed by the
28 * Apache Software Foundation (http://www.apache.org/)."
29 * Alternately, this acknowlegement may appear in the software itself,
30 * if and wherever such third-party acknowlegements normally appear.
31 *
32 * 4. The names "The Jakarta Project", "Commons", and "Apache Software
33 * Foundation" must not be used to endorse or promote products derived
34 * from this software without prior written permission. For written
35 * permission, please contact apache@apache.org.
36 *
37 * 5. Products derived from this software may not be called "Apache"
38 * nor may "Apache" appear in their names without prior written
39 * permission of the Apache Group.
40 *
41 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
42 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
43 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
44 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
45 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
46 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
47 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
48 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
49 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
50 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
51 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52 * SUCH DAMAGE.
53 * ====================================================================
54 *
55 * This software consists of voluntary contributions made by many
56 * individuals on behalf of the Apache Software Foundation. For more
57 * information on the Apache Software Foundation, please see
58 * <http://www.apache.org/>.
59 *
60 * [Additional notices, if required by prior licensing conditions]
61 *
62 */
63
64 package org.apache.commons.httpclient.protocol;
65
66 import java.io.IOException;
67 import java.net.InetAddress;
68 import java.net.Socket;
69 import java.net.UnknownHostException;
70
71 /***
72 * A factory for creating Sockets.
73 *
74 * <p>Both {@link java.lang.Object#equals(java.lang.Object) Object.equals()} and
75 * {@link java.lang.Object#hashCode() Object.hashCode()} should be overridden appropriately.
76 * Protocol socket factories are used to uniquely identify <code>Protocol</code>s and
77 * <code>HostConfiguration</code>s, and <code>equals()</code> and <code>hashCode()</code> are
78 * required for the correct operation of some connection managers.</p>
79 *
80 * @see Protocol
81 *
82 * @author Michael Becke
83 * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
84 *
85 * @since 2.0
86 */
87 public interface ProtocolSocketFactory {
88
89 /***
90 * Gets a new socket connection to the given host.
91 *
92 * @param host the host name/IP
93 * @param port the port on the host
94 * @param clientHost the local host name/IP to bind the socket to
95 * @param clientPort the port on the local machine
96 *
97 * @return Socket a new socket
98 *
99 * @throws IOException if an I/O error occurs while creating the socket
100 * @throws UnknownHostException if the IP address of the host cannot be
101 * determined
102 */
103 Socket createSocket(
104 String host,
105 int port,
106 InetAddress clientHost,
107 int clientPort
108 ) throws IOException, UnknownHostException;
109
110 /***
111 * Gets a new socket connection to the given host.
112 *
113 * @param host the host name/IP
114 * @param port the port on the host
115 *
116 * @return Socket a new socket
117 *
118 * @throws IOException if an I/O error occurs while creating the socket
119 * @throws UnknownHostException if the IP address of the host cannot be
120 * determined
121 */
122 Socket createSocket(
123 String host,
124 int port
125 ) throws IOException, UnknownHostException;
126
127 }
This page was automatically generated by Maven