org.apache.commons.httpclient.protocol

Class DefaultProtocolSocketFactory

Implemented Interfaces:
ProtocolSocketFactory

public class DefaultProtocolSocketFactory
extends java.lang.Object
implements ProtocolSocketFactory

The default class for creating protocol sockets. This class just uses the socket constructors.
Author:
Michael Becke
Since:
2.0

Constructor Summary

DefaultProtocolSocketFactory()
Constructor for DefaultProtocolSocketFactory.

Method Summary

Socket
createSocket(String host, int port)
Socket
createSocket(String host, int port, InetAddress localAddress, int localPort)
Socket
createSocket(String host, int port, InetAddress localAddress, int localPort, HttpConnectionParams params)
Attempts to get a new socket connection to the given host within the given time limit.
boolean
equals(Object obj)
All instances of DefaultProtocolSocketFactory are the same.
int
hashCode()
All instances of DefaultProtocolSocketFactory have the same hash code.

Constructor Details

DefaultProtocolSocketFactory

public DefaultProtocolSocketFactory()
Constructor for DefaultProtocolSocketFactory.

Method Details

createSocket

public Socket createSocket(String host,
                           int port)
            throws IOException,
                   UnknownHostException
Specified by:
createSocket in interface ProtocolSocketFactory
See Also:
ProtocolSocketFactory.createSocket(java.lang.String,int)

createSocket

public Socket createSocket(String host,
                           int port,
                           InetAddress localAddress,
                           int localPort)
            throws IOException,
                   UnknownHostException
Specified by:
createSocket in interface ProtocolSocketFactory
See Also:
createSocket(java.lang.String,int,java.net.InetAddress,int)

createSocket

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

This method employs several techniques to circumvent the limitations of older JREs that do not support connect timeout. When running in JRE 1.4 or above reflection is used to call Socket#connect(SocketAddress endpoint, int timeout) method. When executing in older JREs a controller thread is executed. The controller thread attempts to create a new socket within the given limit of time. If socket constructor does not return until the timeout expires, the controller terminates and throws an ConnectTimeoutException

Specified by:
createSocket in interface ProtocolSocketFactory
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

equals

public boolean equals(Object obj)
All instances of DefaultProtocolSocketFactory are the same.

hashCode

public int hashCode()
All instances of DefaultProtocolSocketFactory have the same hash code.

Copyright (c) 1999-2005 - Apache Software Foundation