Package org.apache.commons.httpclient.protocol

Class ControllerThreadSocketFactory

java.lang.Object

org.apache.commons.httpclient.protocol.ControllerThreadSocketFactory

@Deprecated
public final class ControllerThreadSocketFactory
extends Object

Deprecated.

Jakarta Commons HttpClient 3.x is deprecated in the Jenkins project. It is not recommended to use it in any new code. Instead, use HTTP client API plugins as a dependency in your code. E.g. Apache HttpComponents Client API 4.x Plugin or Async HTTP Client Plugin.

This helper class is intedned to help work around the limitation of older Java versions (older than 1.4) that prevents from specifying a connection timeout when creating a socket. This factory executes a controller thread overssing the process of socket initialisation. If the socket constructor cannot be created within the specified time limit, the controller terminates and throws an ConnectTimeoutException

Since:

3.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ControllerThreadSocketFactory.SocketTask	Deprecated. Helper class for wrapping socket based tasks.

Method Summary

Modifier and Type	Method	Description
static Socket	createSocket(ControllerThreadSocketFactory.SocketTask task, int timeout)	Deprecated.
static Socket	createSocket(ProtocolSocketFactory socketfactory, String host, int port, InetAddress localAddress, int localPort, int timeout)	Deprecated. This method spawns a controller thread overseeing the process of socket initialisation.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

createSocket

public static Socket createSocket(ProtocolSocketFactory socketfactory,
 String host,
 int port,
 InetAddress localAddress,
 int localPort,
 int timeout)
                           throws IOException,
UnknownHostException,
ConnectTimeoutException

Deprecated.

This method spawns a controller thread overseeing the process of socket initialisation. If the socket constructor cannot be created within the specified time limit, the controller terminates and throws an ConnectTimeoutException

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

timeout - the timeout value to be used in milliseconds. If the socket cannot be completed within the given time limit, it will be abandoned

Returns:

a connected Socket

Throws:

IOException - if an I/O error occurs while creating the socket

UnknownHostException - if the IP address of the host cannot be determined

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

createSocket

public static Socket createSocket(ControllerThreadSocketFactory.SocketTask task,
 int timeout)
                           throws IOException,
UnknownHostException,
ConnectTimeoutException

Deprecated.

Throws:

IOException

UnknownHostException

ConnectTimeoutException