org.apache.hc.client5.http.impl.io

Class PoolingHttpClientConnectionManager

java.lang.Object

org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManager

All Implemented Interfaces:

HttpClientConnectionManager

public class PoolingHttpClientConnectionManager
extends java.lang.Object
implements HttpClientConnectionManager

ClientConnectionPoolManager maintains a pool of ManagedHttpClientConnections 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 serviced by leasing a connection from the pool rather than creating a new connection.

ClientConnectionPoolManager maintains a maximum limit of connection on a per route basis and in total. Connection limits, however, can be adjusted using ConnPoolControl methods.

Total time to live (TTL) set at construction time defines maximum life span of persistent connections regardless of their expiration setting. No persistent connection will be re-used past its TTL value.

Since:

4.3

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_CONNECTIONS_PER_ROUTE
static int	DEFAULT_MAX_TOTAL_CONNECTIONS

Constructor Summary

Constructors

Modifier	Constructor and Description
	PoolingHttpClientConnectionManager()
	PoolingHttpClientConnectionManager(<any> socketFactoryRegistry)
	PoolingHttpClientConnectionManager(<any> socketFactoryRegistry, <any> connFactory)
	PoolingHttpClientConnectionManager(<any> socketFactoryRegistry, PoolConcurrencyPolicy poolConcurrencyPolicy, PoolReusePolicy poolReusePolicy, TimeValue timeToLive)
	PoolingHttpClientConnectionManager(<any> socketFactoryRegistry, PoolConcurrencyPolicy poolConcurrencyPolicy, PoolReusePolicy poolReusePolicy, TimeValue timeToLive, <any> connFactory)
	PoolingHttpClientConnectionManager(<any> socketFactoryRegistry, PoolConcurrencyPolicy poolConcurrencyPolicy, PoolReusePolicy poolReusePolicy, TimeValue timeToLive, SchemePortResolver schemePortResolver, DnsResolver dnsResolver, <any> connFactory)
	PoolingHttpClientConnectionManager(<any> socketFactoryRegistry, PoolConcurrencyPolicy poolConcurrencyPolicy, TimeValue timeToLive, <any> connFactory)
protected	PoolingHttpClientConnectionManager(HttpClientConnectionOperator httpClientConnectionOperator, <any> pool, <any> connFactory)
protected	PoolingHttpClientConnectionManager(HttpClientConnectionOperator httpClientConnectionOperator, PoolConcurrencyPolicy poolConcurrencyPolicy, PoolReusePolicy poolReusePolicy, TimeValue timeToLive, <any> connFactory)

Method Summary

Modifier and Type	Method and Description
void	close()
void	close(CloseMode closeMode)
void	closeExpired()
void	closeIdle(TimeValue idleTime)
void	connect(ConnectionEndpoint endpoint, TimeValue connectTimeout, HttpContext context) Connects the endpoint to the initial hop (connection target in case of a direct route or to the first proxy hop in case of a route via a proxy or multiple proxies).
int	getDefaultMaxPerRoute()
SocketConfig	getDefaultSocketConfig()
int	getMaxPerRoute(HttpRoute route)
int	getMaxTotal()
java.util.Set<HttpRoute>	getRoutes()
PoolStats	getStats(HttpRoute route)
PoolStats	getTotalStats()
TimeValue	getValidateAfterInactivity()
LeaseRequest	lease(java.lang.String id, HttpRoute route, java.lang.Object state)
LeaseRequest	lease(java.lang.String id, HttpRoute route, Timeout requestTimeout, java.lang.Object state) Returns a LeaseRequest object which can be used to obtain a ConnectionEndpoint to cancel the request by calling LeaseRequest#cancel().
void	release(ConnectionEndpoint endpoint, java.lang.Object state, TimeValue keepAlive) Releases the endpoint back to the manager making it potentially re-usable by other consumers.
void	setDefaultMaxPerRoute(int max)
void	setDefaultSocketConfig(SocketConfig defaultSocketConfig)
void	setMaxPerRoute(HttpRoute route, int max)
void	setMaxTotal(int max)
void	setValidateAfterInactivity(TimeValue validateAfterInactivity) Defines period of inactivity after which persistent connections must be re-validated prior to being lease(String, HttpRoute, Object) leased} to the consumer.
void	upgrade(ConnectionEndpoint endpoint, HttpContext context) Upgrades transport security of the given endpoint by using the TLS security protocol.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_TOTAL_CONNECTIONS

public static final int DEFAULT_MAX_TOTAL_CONNECTIONS

See Also:

Constant Field Values

DEFAULT_MAX_CONNECTIONS_PER_ROUTE

public static final int DEFAULT_MAX_CONNECTIONS_PER_ROUTE

See Also:

Constant Field Values

Constructor Detail

PoolingHttpClientConnectionManager

public PoolingHttpClientConnectionManager()

PoolingHttpClientConnectionManager

public PoolingHttpClientConnectionManager(<any> socketFactoryRegistry)

PoolingHttpClientConnectionManager

public PoolingHttpClientConnectionManager(<any> socketFactoryRegistry,
                                          <any> connFactory)

PoolingHttpClientConnectionManager

public PoolingHttpClientConnectionManager(<any> socketFactoryRegistry,
                                          PoolConcurrencyPolicy poolConcurrencyPolicy,
                                          TimeValue timeToLive,
                                          <any> connFactory)

PoolingHttpClientConnectionManager

public PoolingHttpClientConnectionManager(<any> socketFactoryRegistry,
                                          PoolConcurrencyPolicy poolConcurrencyPolicy,
                                          PoolReusePolicy poolReusePolicy,
                                          TimeValue timeToLive)

PoolingHttpClientConnectionManager

public PoolingHttpClientConnectionManager(<any> socketFactoryRegistry,
                                          PoolConcurrencyPolicy poolConcurrencyPolicy,
                                          PoolReusePolicy poolReusePolicy,
                                          TimeValue timeToLive,
                                          <any> connFactory)

PoolingHttpClientConnectionManager

public PoolingHttpClientConnectionManager(<any> socketFactoryRegistry,
                                          PoolConcurrencyPolicy poolConcurrencyPolicy,
                                          PoolReusePolicy poolReusePolicy,
                                          TimeValue timeToLive,
                                          SchemePortResolver schemePortResolver,
                                          DnsResolver dnsResolver,
                                          <any> connFactory)

PoolingHttpClientConnectionManager

protected PoolingHttpClientConnectionManager(HttpClientConnectionOperator httpClientConnectionOperator,
                                             PoolConcurrencyPolicy poolConcurrencyPolicy,
                                             PoolReusePolicy poolReusePolicy,
                                             TimeValue timeToLive,
                                             <any> connFactory)

PoolingHttpClientConnectionManager

protected PoolingHttpClientConnectionManager(HttpClientConnectionOperator httpClientConnectionOperator,
                                             <any> pool,
                                             <any> connFactory)

Method Detail

close

public void close()

close

public void close(CloseMode closeMode)

lease

public LeaseRequest lease(java.lang.String id,
                          HttpRoute route,
                          java.lang.Object state)

lease

public LeaseRequest lease(java.lang.String id,
                          HttpRoute route,
                          Timeout requestTimeout,
                          java.lang.Object state)

Description copied from interface: HttpClientConnectionManager

Returns a LeaseRequest object which can be used to obtain a ConnectionEndpoint to cancel the request by calling LeaseRequest#cancel().

Please note that newly allocated endpoints can be leased disconnected. The consumer of the endpoint is responsible for fully establishing the route to the endpoint target by calling HttpClientConnectionManager.connect(ConnectionEndpoint, TimeValue, HttpContext) in order to connect directly to the target or to the first proxy hop, and optionally calling HttpClientConnectionManager.upgrade(ConnectionEndpoint, HttpContext) method to upgrade the underlying transport to Transport Layer Security after having executed a CONNECT method to all intermediate proxy hops.

Specified by:

lease in interface HttpClientConnectionManager

Parameters:

id - unique operation ID or null.

route - HTTP route of the requested connection.

requestTimeout - lease request timeout.

state - expected state of the connection or null if the connection is not expected to carry any state.

release

public void release(ConnectionEndpoint endpoint,
                    java.lang.Object state,
                    TimeValue keepAlive)

Description copied from interface: HttpClientConnectionManager

Releases the endpoint back to the manager making it potentially re-usable by other consumers. Optionally, the maximum period of how long the manager should keep the connection alive can be defined using validDuration and timeUnit parameters.

Specified by:

release in interface HttpClientConnectionManager

Parameters:

endpoint - the managed endpoint.

state - the new connection state of null if state-less.

keepAlive - the duration of time this connection is valid for reuse.

connect

public void connect(ConnectionEndpoint endpoint,
                    TimeValue connectTimeout,
                    HttpContext context)
             throws java.io.IOException

Description copied from interface: HttpClientConnectionManager

Connects the endpoint to the initial hop (connection target in case of a direct route or to the first proxy hop in case of a route via a proxy or multiple proxies).

Specified by:

connect in interface HttpClientConnectionManager

Parameters:

endpoint - the managed endpoint.

connectTimeout - connect timeout.

context - the actual HTTP context.

Throws:

java.io.IOException

upgrade

public void upgrade(ConnectionEndpoint endpoint,
                    HttpContext context)
             throws java.io.IOException

Description copied from interface: HttpClientConnectionManager

Upgrades transport security of the given endpoint by using the TLS security protocol.

Specified by:

upgrade in interface HttpClientConnectionManager

Parameters:

endpoint - the managed endpoint.

context - the actual HTTP context.

Throws:

java.io.IOException

closeIdle

public void closeIdle(TimeValue idleTime)

closeExpired

public void closeExpired()

getRoutes

public java.util.Set<HttpRoute> getRoutes()

getMaxTotal

public int getMaxTotal()

setMaxTotal

public void setMaxTotal(int max)

getDefaultMaxPerRoute

public int getDefaultMaxPerRoute()

setDefaultMaxPerRoute

public void setDefaultMaxPerRoute(int max)

getMaxPerRoute

public int getMaxPerRoute(HttpRoute route)

setMaxPerRoute

public void setMaxPerRoute(HttpRoute route,
                           int max)

getTotalStats

public PoolStats getTotalStats()

getStats

public PoolStats getStats(HttpRoute route)

getDefaultSocketConfig

public SocketConfig getDefaultSocketConfig()

setDefaultSocketConfig

public void setDefaultSocketConfig(SocketConfig defaultSocketConfig)

getValidateAfterInactivity

public TimeValue getValidateAfterInactivity()

Since:

4.4

See Also:

setValidateAfterInactivity(TimeValue)

setValidateAfterInactivity

public void setValidateAfterInactivity(TimeValue validateAfterInactivity)

Defines period of inactivity after which persistent connections must be re-validated prior to being lease(String, HttpRoute, Object) leased} to the consumer. Negative values passed to this method disable connection validation. This check helps detect connections that have become stale (half-closed) while kept inactive in the pool.

Since:

4.4