public class

ThreadSafeClientConnManager

extends Object
implements ClientConnectionManager
java.lang.Object
   ↳ org.apache.http.impl.conn.tsccm.ThreadSafeClientConnManager

Class Overview

Manages a pool of client connections and is able to service connection requests from multiple execution threads. Connections are pooled on a per route basis. A request for a route which already the manager has persistent connections for available in the pool will be services by leasing a connection from the pool rather than creating a brand new connection.

ThreadSafeClientConnManager maintains a maximum limit of connection on a per route basis and in total. Per default this implementation will create no more than than 2 concurrent connections per given route and no more 20 connections in total. For many real-world applications these limits may prove too constraining, especially if they use HTTP as a transport protocol for their services. Connection limits, however, can be adjusted using HTTP parameters.

Summary

Fields
protected final ClientConnectionOperator connOperator The operator for opening and updating connections.
protected final ConnPerRouteBean connPerRoute
protected final AbstractConnPool connectionPool
protected final ConnPoolByRoute pool The pool of connections being managed.
protected final SchemeRegistry schemeRegistry The schemes supported by this connection manager.
Public Constructors
ThreadSafeClientConnManager(SchemeRegistry schreg)
Creates a new thread safe connection manager.
ThreadSafeClientConnManager()
ThreadSafeClientConnManager(SchemeRegistry schreg, long connTTL, TimeUnit connTTLTimeUnit)
Creates a new thread safe connection manager.
ThreadSafeClientConnManager(HttpParams params, SchemeRegistry schreg)
This constructor is deprecated. use ThreadSafeClientConnManager(SchemeRegistry)
Public Methods
void closeExpiredConnections()
Closes all expired connections in the pool.
void closeIdleConnections(long idleTimeout, TimeUnit tunit)
Closes idle connections in the pool.
int getConnectionsInPool(HttpRoute route)
Gets the total number of pooled connections for the given route.
int getConnectionsInPool()
Gets the total number of pooled connections.
int getDefaultMaxPerRoute()
int getMaxForRoute(HttpRoute route)
int getMaxTotal()
since 4.1
SchemeRegistry getSchemeRegistry()
Obtains the scheme registry used by this manager.
void releaseConnection(ManagedClientConnection conn, long validDuration, TimeUnit timeUnit)
Releases a connection for use by others.
ClientConnectionRequest requestConnection(HttpRoute route, Object state)
Returns a new ClientConnectionRequest, from which a ManagedClientConnection can be obtained or the request can be aborted.
void setDefaultMaxPerRoute(int max)
void setMaxForRoute(HttpRoute route, int max)
void setMaxTotal(int max)
since 4.1
void shutdown()
Shuts down this connection manager and releases allocated resources.
Protected Methods
ClientConnectionOperator createConnectionOperator(SchemeRegistry schreg)
Hook for creating the connection operator.
AbstractConnPool createConnectionPool(HttpParams params)
This method is deprecated. use #createConnectionPool(long, TimeUnit))
ConnPoolByRoute createConnectionPool(long connTTL, TimeUnit connTTLTimeUnit)
Hook for creating the connection pool.
void finalize()
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.apache.http.conn.ClientConnectionManager

Fields

protected final ClientConnectionOperator connOperator

Also: HttpClient

The operator for opening and updating connections.

protected final ConnPerRouteBean connPerRoute

Also: HttpClient

protected final AbstractConnPool connectionPool

Also: HttpClient

protected final ConnPoolByRoute pool

Also: HttpClient

The pool of connections being managed.

protected final SchemeRegistry schemeRegistry

Also: HttpClient

The schemes supported by this connection manager.

Public Constructors

public ThreadSafeClientConnManager (SchemeRegistry schreg)

Also: HttpClient

Creates a new thread safe connection manager.

Parameters
schreg the scheme registry.

public ThreadSafeClientConnManager ()

Also: HttpClient

public ThreadSafeClientConnManager (SchemeRegistry schreg, long connTTL, TimeUnit connTTLTimeUnit)

Also: HttpClient

Creates a new thread safe connection manager.

Parameters
schreg the scheme registry.
connTTL max connection lifetime, <=0 implies "infinity"
connTTLTimeUnit TimeUnit of connTTL

public ThreadSafeClientConnManager (HttpParams params, SchemeRegistry schreg)

Also: HttpClient

This constructor is deprecated.
use ThreadSafeClientConnManager(SchemeRegistry)

Creates a new thread safe connection manager.

Parameters
params the parameters for this manager.
schreg the scheme registry.

Public Methods

public void closeExpiredConnections ()

Also: HttpClient

Closes all expired connections in the pool. Open connections in the pool that have not been used for the timespan defined when the connection was released will be closed. Currently allocated connections are not subject to this method. Times will be checked with milliseconds precision.

public void closeIdleConnections (long idleTimeout, TimeUnit tunit)

Also: HttpClient

Closes idle connections in the pool. Open connections in the pool that have not been used for the timespan given by the argument will be closed. Currently allocated connections are not subject to this method. Times will be checked with milliseconds precision All expired connections will also be closed.

Parameters
idleTimeout the idle time of connections to be closed
tunit the unit for the idletime

public int getConnectionsInPool (HttpRoute route)

Also: HttpClient

Gets the total number of pooled connections for the given route. This is the total number of connections that have been created and are still in use by this connection manager for the route. This value will not exceed the maximum number of connections per host.

Parameters
route the route in question
Returns
  • the total number of pooled connections for that route

public int getConnectionsInPool ()

Also: HttpClient

Gets the total number of pooled connections. This is the total number of connections that have been created and are still in use by this connection manager. This value will not exceed the maximum number of connections in total.

Returns
  • the total number of pooled connections

public int getDefaultMaxPerRoute ()

Also: HttpClient

public int getMaxForRoute (HttpRoute route)

Also: HttpClient

public int getMaxTotal ()

Also: HttpClient

since 4.1

public SchemeRegistry getSchemeRegistry ()

Also: HttpClient

Obtains the scheme registry used by this manager.

Returns
  • the scheme registry, never null

public void releaseConnection (ManagedClientConnection conn, long validDuration, TimeUnit timeUnit)

Also: HttpClient

Releases a connection for use by others. You may optionally specify how long the connection is valid to be reused. Values <= 0 are considered to be valid forever. If the connection is not marked as reusable, the connection will not be reused regardless of the valid duration. If the connection has been released before, the call will be ignored.

Parameters
conn the connection to release
validDuration the duration of time this connection is valid for reuse
timeUnit the unit of time validDuration is measured in

public ClientConnectionRequest requestConnection (HttpRoute route, Object state)

Also: HttpClient

Returns a new ClientConnectionRequest, from which a ManagedClientConnection can be obtained or the request can be aborted.

public void setDefaultMaxPerRoute (int max)

Also: HttpClient

public void setMaxForRoute (HttpRoute route, int max)

Also: HttpClient

public void setMaxTotal (int max)

Also: HttpClient

since 4.1

public void shutdown ()

Also: HttpClient

Shuts down this connection manager and releases allocated resources. This includes closing all connections, whether they are currently used or not.

Protected Methods

protected ClientConnectionOperator createConnectionOperator (SchemeRegistry schreg)

Also: HttpClient

Hook for creating the connection operator. It is called by the constructor. Derived classes can override this method to change the instantiation of the operator. The default implementation here instantiates DefaultClientConnectionOperator.

Parameters
schreg the scheme registry.
Returns
  • the connection operator to use

protected AbstractConnPool createConnectionPool (HttpParams params)

Also: HttpClient

This method is deprecated.
use #createConnectionPool(long, TimeUnit))

Hook for creating the connection pool.

Returns
  • the connection pool to use

protected ConnPoolByRoute createConnectionPool (long connTTL, TimeUnit connTTLTimeUnit)

Also: HttpClient

Hook for creating the connection pool.

Returns
  • the connection pool to use

protected void finalize ()

Throws
Throwable