public class

DefaultClientConnectionOperator

extends Object
implements ClientConnectionOperator
java.lang.Object
   ↳ org.apache.http.impl.conn.DefaultClientConnectionOperator

Class Overview

Default implementation of a ClientConnectionOperator. It uses a SchemeRegistry to look up SchemeSocketFactory objects.

This connection operator is multihome network aware and will attempt to retry failed connects against all known IP addresses sequentially until the connect is successful or all known addresses fail to respond. Please note the same CONNECTION_TIMEOUT value will be used for each connection attempt, so in the worst case the total elapsed time before timeout can be CONNECTION_TIMEOUT * n where n is the number of IP addresses of the given host. One can disable multihome support by overriding the resolveHostname(String) method and returning only one IP address for the given host name.

The following parameters can be used to customize the behavior of this class:

Summary

Fields
protected final SchemeRegistry schemeRegistry The scheme registry for looking up socket factories.
Public Constructors
DefaultClientConnectionOperator(SchemeRegistry schemes)
Creates a new client connection operator for the given scheme registry.
Public Methods
OperatedClientConnection createConnection()
Creates a new connection that can be operated.
void openConnection(OperatedClientConnection conn, HttpHost target, InetAddress local, HttpContext context, HttpParams params)
Opens a connection to the given target host.
void updateSecureConnection(OperatedClientConnection conn, HttpHost target, HttpContext context, HttpParams params)
Updates a connection with a layered secure connection.
Protected Methods
void prepareSocket(Socket sock, HttpContext context, HttpParams params)
Performs standard initializations on a newly created socket.
InetAddress[] resolveHostname(String host)
Resolves the given host name to an array of corresponding IP addresses, based on the configured name service on the system.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.apache.http.conn.ClientConnectionOperator

Fields

protected final SchemeRegistry schemeRegistry

Also: HttpClient

The scheme registry for looking up socket factories.

Public Constructors

public DefaultClientConnectionOperator (SchemeRegistry schemes)

Also: HttpClient

Creates a new client connection operator for the given scheme registry.

Parameters
schemes the scheme registry

Public Methods

public OperatedClientConnection createConnection ()

Also: HttpClient

Creates a new connection that can be operated.

Returns
  • a new, unopened connection for use with this operator

public void openConnection (OperatedClientConnection conn, HttpHost target, InetAddress local, HttpContext context, HttpParams params)

Also: HttpClient

Opens a connection to the given target host.

Parameters
conn the connection to open
target the target host to connect to
local the local address to route from, or null for the default
context the context for the connection
params the parameters for the connection
Throws
IOException

public void updateSecureConnection (OperatedClientConnection conn, HttpHost target, HttpContext context, HttpParams params)

Also: HttpClient

Updates a connection with a layered secure connection. The typical use of this method is to update a tunnelled plain connection (HTTP) to a secure TLS/SSL connection (HTTPS).

Parameters
conn the open connection to update
target the target host for the updated connection. The connection must already be open or tunnelled to the host and port, but the scheme of the target will be used to create a layered connection.
context the context for the connection
params the parameters for the updated connection
Throws
IOException

Protected Methods

protected void prepareSocket (Socket sock, HttpContext context, HttpParams params)

Also: HttpClient

Performs standard initializations on a newly created socket.

Parameters
sock the socket to prepare
context the context for the connection
params the parameters from which to prepare the socket
Throws
IOException in case of an IO problem

protected InetAddress[] resolveHostname (String host)

Also: HttpClient

Resolves the given host name to an array of corresponding IP addresses, based on the configured name service on the system.

Parameters
host host name to resolve
Returns
  • array of IP addresses
Throws
UnknownHostException if no IP address for the host could be determined.