Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.apache.commons.httpclient.protocol

Interface ProtocolSocketFactory

Known Subinterfaces:
SecureProtocolSocketFactory
Known Implementing Classes:
DefaultProtocolSocketFactory, SSLProtocolSocketFactory
public interface ProtocolSocketFactory
A factory for creating Sockets.

Both Object.equals() and Object.hashCode() should be overridden appropriately. Protocol socket factories are used to uniquely identify Protocols and HostConfigurations, and equals() and hashCode() are required for the correct operation of some connection managers.

Authors:
Michael Becke
Mike Bowler

Since:
2.0

See Also:
Protocol

Method Summary

Socket
createSocket(String host, int port)
Gets a new socket connection to the given host.
Socket
createSocket(String host, int port, InetAddress localAddress, int localPort)
Gets a new socket connection to the given host.
Socket
createSocket(String host, int port, InetAddress localAddress, int localPort, HttpConnectionParams params)
Gets a new socket connection to the given host.

Method Details

createSocket

public Socket createSocket(String host,
                           int port)
            throws IOException,
                   UnknownHostException
Gets a new socket connection to the given host.

Parameters:
host - the host name/IP
port - the port on the host

Returns:
Socket a new socket

createSocket

public Socket createSocket(String host,
                           int port,
                           InetAddress localAddress,
                           int localPort)
            throws IOException,
                   UnknownHostException
Gets a new socket connection to the given host.

Parameters:
host - the host name/IP
port - the port on the host
localAddress - the local host name/IP to bind the socket to
localPort - the port on the local machine

Returns:
Socket a new socket

createSocket

public Socket createSocket(String host,
                           int port,
                           InetAddress localAddress,
                           int localPort,
                           HttpConnectionParams params)
            throws IOException,
                   UnknownHostException,
                   ConnectTimeoutException
Gets a new socket connection to the given host.

Parameters:
host - the host name/IP
port - the port on the host
localAddress - the local host name/IP to bind the socket to
localPort - the port on the local machine
params - Http connection parameters

Returns:
Socket a new socket

Throws:
ConnectTimeoutException - if socket cannot be connected within the given time limit

Since:
3.0

Overview Package Tree Index Deprecated About
Copyright (c) 1999-2005 - Apache Software Foundation