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

Class PoolingHttpClientConnectionManagerBuilder

java.lang.Object

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

public class PoolingHttpClientConnectionManagerBuilder
extends Object

Builder for PoolingHttpClientConnectionManager instances.

Since:

5.0

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PoolingHttpClientConnectionManagerBuilder()

Method Summary

Modifier and Type	Method and Description
PoolingHttpClientConnectionManager	build()
static PoolingHttpClientConnectionManagerBuilder	create()
protected HttpClientConnectionOperator	createConnectionOperator(SchemePortResolver schemePortResolver, DnsResolver dnsResolver, TlsSocketStrategy tlsSocketStrategy)
PoolingHttpClientConnectionManagerBuilder	setConnectionConfigResolver(Resolver<HttpRoute,ConnectionConfig> connectionConfigResolver) Sets Resolver of ConnectionConfig on a per route basis.
PoolingHttpClientConnectionManagerBuilder	setConnectionFactory(HttpConnectionFactory<ManagedHttpClientConnection> connectionFactory) Sets HttpConnectionFactory instance.
PoolingHttpClientConnectionManagerBuilder	setConnectionTimeToLive(TimeValue timeToLive) Deprecated. Use setDefaultConnectionConfig(ConnectionConfig).
PoolingHttpClientConnectionManagerBuilder	setConnPoolListener(ConnPoolListener<HttpRoute> connPoolListener) Sets a ConnPoolListener.
PoolingHttpClientConnectionManagerBuilder	setConnPoolPolicy(PoolReusePolicy poolReusePolicy) Sets PoolReusePolicy value.
PoolingHttpClientConnectionManagerBuilder	setDefaultConnectionConfig(ConnectionConfig config) Sets the same ConnectionConfig for all routes.
PoolingHttpClientConnectionManagerBuilder	setDefaultSocketConfig(SocketConfig config) Sets the same SocketConfig for all routes.
PoolingHttpClientConnectionManagerBuilder	setDefaultTlsConfig(TlsConfig config) Sets the same TlsConfig for all hosts.
PoolingHttpClientConnectionManagerBuilder	setDnsResolver(DnsResolver dnsResolver) Sets DnsResolver instance.
PoolingHttpClientConnectionManagerBuilder	setMaxConnPerRoute(int maxConnPerRoute) Sets maximum connection per route value.
PoolingHttpClientConnectionManagerBuilder	setMaxConnTotal(int maxConnTotal) Sets maximum total connection value.
PoolingHttpClientConnectionManagerBuilder	setOffLockDisposalEnabled(boolean enabled) Enable or disable off-lock connection disposal for blocking I/O pools.
PoolingHttpClientConnectionManagerBuilder	setPoolConcurrencyPolicy(PoolConcurrencyPolicy poolConcurrencyPolicy) Sets PoolConcurrencyPolicy value.
PoolingHttpClientConnectionManagerBuilder	setSchemePortResolver(SchemePortResolver schemePortResolver) Sets SchemePortResolver instance.
PoolingHttpClientConnectionManagerBuilder	setSocketConfigResolver(Resolver<HttpRoute,SocketConfig> socketConfigResolver) Sets Resolver of SocketConfig on a per route basis.
PoolingHttpClientConnectionManagerBuilder	setSSLSocketFactory(LayeredConnectionSocketFactory sslSocketFactory) Deprecated. Use setTlsSocketStrategy(TlsSocketStrategy)
PoolingHttpClientConnectionManagerBuilder	setTlsConfigResolver(Resolver<HttpHost,TlsConfig> tlsConfigResolver) Sets Resolver of TlsConfig on a per host basis.
PoolingHttpClientConnectionManagerBuilder	setTlsSocketStrategy(TlsSocketStrategy tlsSocketStrategy) Sets TlsSocketStrategy instance.
PoolingHttpClientConnectionManagerBuilder	setValidateAfterInactivity(TimeValue validateAfterInactivity) Deprecated. Use setDefaultConnectionConfig(ConnectionConfig).
PoolingHttpClientConnectionManagerBuilder	useSystemProperties() Deprecated. This method is now redundant and calls to it can be removed.

Methods inherited from class java.lang.Object

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

Constructor Detail

PoolingHttpClientConnectionManagerBuilder

@Internal
protected PoolingHttpClientConnectionManagerBuilder()

Method Detail

create

public static PoolingHttpClientConnectionManagerBuilder create()

setConnectionFactory

public final PoolingHttpClientConnectionManagerBuilder setConnectionFactory(HttpConnectionFactory<ManagedHttpClientConnection> connectionFactory)

Sets HttpConnectionFactory instance.

Returns:

this instance.

setSSLSocketFactory

@Deprecated
public final PoolingHttpClientConnectionManagerBuilder setSSLSocketFactory(LayeredConnectionSocketFactory sslSocketFactory)

Deprecated. Use setTlsSocketStrategy(TlsSocketStrategy)

Sets LayeredConnectionSocketFactory instance.

Returns:

this instance.

setTlsSocketStrategy

public final PoolingHttpClientConnectionManagerBuilder setTlsSocketStrategy(TlsSocketStrategy tlsSocketStrategy)

Sets TlsSocketStrategy instance.

Returns:

this instance.

setDnsResolver

public final PoolingHttpClientConnectionManagerBuilder setDnsResolver(DnsResolver dnsResolver)

Sets DnsResolver instance.

Returns:

this instance.

setSchemePortResolver

public final PoolingHttpClientConnectionManagerBuilder setSchemePortResolver(SchemePortResolver schemePortResolver)

Sets SchemePortResolver instance.

Returns:

this instance.

setPoolConcurrencyPolicy

public final PoolingHttpClientConnectionManagerBuilder setPoolConcurrencyPolicy(PoolConcurrencyPolicy poolConcurrencyPolicy)

Sets PoolConcurrencyPolicy value.

Returns:

this instance.

setConnPoolPolicy

public final PoolingHttpClientConnectionManagerBuilder setConnPoolPolicy(PoolReusePolicy poolReusePolicy)

Sets PoolReusePolicy value.

Returns:

this instance.

setMaxConnTotal

public final PoolingHttpClientConnectionManagerBuilder setMaxConnTotal(int maxConnTotal)

Sets maximum total connection value.

Returns:

this instance.

setMaxConnPerRoute

public final PoolingHttpClientConnectionManagerBuilder setMaxConnPerRoute(int maxConnPerRoute)

Sets maximum connection per route value.

Returns:

this instance.

setConnPoolListener

public final PoolingHttpClientConnectionManagerBuilder setConnPoolListener(ConnPoolListener<HttpRoute> connPoolListener)

Sets a ConnPoolListener. This can be used to subscribe to underlying connection pool events (if it supports it).

Returns:

this instance.

Since:

5.7

setDefaultSocketConfig

public final PoolingHttpClientConnectionManagerBuilder setDefaultSocketConfig(SocketConfig config)

Sets the same SocketConfig for all routes.

Returns:

this instance.

setSocketConfigResolver

public final PoolingHttpClientConnectionManagerBuilder setSocketConfigResolver(Resolver<HttpRoute,SocketConfig> socketConfigResolver)

Sets Resolver of SocketConfig on a per route basis.

Returns:

this instance.

Since:

5.2

setDefaultConnectionConfig

public final PoolingHttpClientConnectionManagerBuilder setDefaultConnectionConfig(ConnectionConfig config)

Sets the same ConnectionConfig for all routes.

Returns:

this instance.

Since:

5.2

setConnectionConfigResolver

public final PoolingHttpClientConnectionManagerBuilder setConnectionConfigResolver(Resolver<HttpRoute,ConnectionConfig> connectionConfigResolver)

Sets Resolver of ConnectionConfig on a per route basis.

Returns:

this instance.

Since:

5.2

setDefaultTlsConfig

public final PoolingHttpClientConnectionManagerBuilder setDefaultTlsConfig(TlsConfig config)

Sets the same TlsConfig for all hosts.

Returns:

this instance.

Since:

5.2

setTlsConfigResolver

public final PoolingHttpClientConnectionManagerBuilder setTlsConfigResolver(Resolver<HttpHost,TlsConfig> tlsConfigResolver)

Sets Resolver of TlsConfig on a per host basis.

Returns:

this instance.

Since:

5.2

setConnectionTimeToLive

@Deprecated
public final PoolingHttpClientConnectionManagerBuilder setConnectionTimeToLive(TimeValue timeToLive)

Deprecated. Use setDefaultConnectionConfig(ConnectionConfig).

Sets maximum time to live for persistent connections

Returns:

this instance.

setValidateAfterInactivity

@Deprecated
public final PoolingHttpClientConnectionManagerBuilder setValidateAfterInactivity(TimeValue validateAfterInactivity)

Deprecated. Use setDefaultConnectionConfig(ConnectionConfig).

Sets period after inactivity after which persistent connections must be checked to ensure they are still valid.

Returns:

this instance.

useSystemProperties

@Deprecated
public final PoolingHttpClientConnectionManagerBuilder useSystemProperties()

Deprecated. This method is now redundant and calls to it can be removed.

Ignored.

setOffLockDisposalEnabled

@Experimental
public final PoolingHttpClientConnectionManagerBuilder setOffLockDisposalEnabled(boolean enabled)

Enable or disable off-lock connection disposal for blocking I/O pools.

When enabled, graceful connection closes are deferred and performed outside the core pool synchronization in PoolingHttpClientConnectionManager. This reduces the time spent holding internal locks at the cost of slightly more complex disposal logic. Immediate closes CloseMode.IMMEDIATE are still executed on the caller thread.

Parameters:

enabled - true to enable off-lock disposal, false to disable

Returns:

this builder

Since:

5.6

createConnectionOperator

@Internal
protected HttpClientConnectionOperator createConnectionOperator(SchemePortResolver schemePortResolver,
                                                                          DnsResolver dnsResolver,
                                                                          TlsSocketStrategy tlsSocketStrategy)

build

public PoolingHttpClientConnectionManager build()