Top Description Fields Constructors Methods
org.apache.hc.client5.http.impl.io

public Class PoolingHttpClientConnectionManagerBuilder

extends Object
Class Inheritance
Imports
org.apache.hc.client5.http.DnsResolver, .HttpRoute, .SchemePortResolver, org.apache.hc.client5.http.config.ConnectionConfig, .TlsConfig, org.apache.hc.client5.http.io.ManagedHttpClientConnection, org.apache.hc.client5.http.socket.ConnectionSocketFactory, .LayeredConnectionSocketFactory, .PlainConnectionSocketFactory, org.apache.hc.client5.http.ssl.SSLConnectionSocketFactory, org.apache.hc.core5.function.Resolver, org.apache.hc.core5.http.HttpHost, .URIScheme, org.apache.hc.core5.http.config.RegistryBuilder, org.apache.hc.core5.http.io.HttpConnectionFactory, .SocketConfig, org.apache.hc.core5.pool.PoolConcurrencyPolicy, .PoolReusePolicy, org.apache.hc.core5.util.TimeValue
Builder for PoolingHttpClientConnectionManager instances.

When a particular component is not explicitly set this class will use its default implementation. System properties will be taken into account when configuring the default implementations when useSystemProperties() method is called prior to calling build().

Since
5.0

Field Summary

Modifier and TypeField and Description
private Resolver<HttpRoute, ConnectionConfig>
connectionConfigResolver

private HttpConnectionFactory<ManagedHttpClientConnection>
connectionFactory

private DnsResolver
dnsResolver

private int
maxConnPerRoute

private int
maxConnTotal

private PoolConcurrencyPolicy
poolConcurrencyPolicy

private PoolReusePolicy
poolReusePolicy

private SchemePortResolver
schemePortResolver

private Resolver<HttpRoute, SocketConfig>
socketConfigResolver

private LayeredConnectionSocketFactory
sslSocketFactory

private boolean
systemProperties

private Resolver<HttpHost, TlsConfig>
tlsConfigResolver

Constructor Summary

AccessConstructor and Description
pack-priv
PoolingHttpClientConnectionManagerBuilder()

Method Summary

Modifier and TypeMethod and Description
public PoolingHttpClientConnectionManager
build()

public static PoolingHttpClientConnectionManagerBuilder
create()

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

Assigns Resolver of ConnectionConfig on a per route basis.

public final PoolingHttpClientConnectionManagerBuilder
setConnectionFactory(final HttpConnectionFactory<ManagedHttpClientConnection> connectionFactory)

Assigns HttpConnectionFactory instance.

public final PoolingHttpClientConnectionManagerBuilder
setConnectionTimeToLive(final TimeValue timeToLive)

Deprecated Use setDefaultConnectionConfig(ConnectionConfig).
Sets maximum time to live for persistent connections
public final PoolingHttpClientConnectionManagerBuilder
setConnPoolPolicy(final PoolReusePolicy poolReusePolicy)

Assigns PoolReusePolicy value.

public final PoolingHttpClientConnectionManagerBuilder
setDefaultConnectionConfig(final ConnectionConfig config)

Assigns the same ConnectionConfig for all routes.

public final PoolingHttpClientConnectionManagerBuilder
setDefaultSocketConfig(final SocketConfig config)

Assigns the same SocketConfig for all routes.

public final PoolingHttpClientConnectionManagerBuilder
setDefaultTlsConfig(final TlsConfig config)

Assigns the same TlsConfig for all hosts.

public final PoolingHttpClientConnectionManagerBuilder
setDnsResolver(final DnsResolver dnsResolver)

Assigns DnsResolver instance.

public final PoolingHttpClientConnectionManagerBuilder
setMaxConnPerRoute(final int maxConnPerRoute)

Assigns maximum connection per route value.

public final PoolingHttpClientConnectionManagerBuilder
setMaxConnTotal(final int maxConnTotal)

Assigns maximum total connection value.

public final PoolingHttpClientConnectionManagerBuilder
setPoolConcurrencyPolicy(final PoolConcurrencyPolicy poolConcurrencyPolicy)

Assigns PoolConcurrencyPolicy value.

public final PoolingHttpClientConnectionManagerBuilder
setSchemePortResolver(final SchemePortResolver schemePortResolver)

Assigns SchemePortResolver instance.

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

Assigns Resolver of SocketConfig on a per route basis.

public final PoolingHttpClientConnectionManagerBuilder
setSSLSocketFactory(final LayeredConnectionSocketFactory sslSocketFactory)

Assigns LayeredConnectionSocketFactory instance.

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

Assigns Resolver of TlsConfig on a per host basis.

public final PoolingHttpClientConnectionManagerBuilder
setValidateAfterInactivity(final TimeValue validateAfterInactivity)

Deprecated Use setDefaultConnectionConfig(ConnectionConfig).
Sets period after inactivity after which persistent connections must be checked to ensure they are still valid.
public final PoolingHttpClientConnectionManagerBuilder
useSystemProperties()

Use system properties when creating and configuring default implementations.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

connectionConfigResolverback to summary
private Resolver<HttpRoute, ConnectionConfig> connectionConfigResolver
connectionFactoryback to summary
private HttpConnectionFactory<ManagedHttpClientConnection> connectionFactory
dnsResolverback to summary
private DnsResolver dnsResolver
maxConnPerRouteback to summary
private int maxConnPerRoute
maxConnTotalback to summary
private int maxConnTotal
poolConcurrencyPolicyback to summary
private PoolConcurrencyPolicy poolConcurrencyPolicy
poolReusePolicyback to summary
private PoolReusePolicy poolReusePolicy
schemePortResolverback to summary
private SchemePortResolver schemePortResolver
socketConfigResolverback to summary
private Resolver<HttpRoute, SocketConfig> socketConfigResolver
sslSocketFactoryback to summary
private LayeredConnectionSocketFactory sslSocketFactory
systemPropertiesback to summary
private boolean systemProperties
tlsConfigResolverback to summary
private Resolver<HttpHost, TlsConfig> tlsConfigResolver

Constructor Detail

PoolingHttpClientConnectionManagerBuilderback to summary
pack-priv PoolingHttpClientConnectionManagerBuilder()

Method Detail

buildback to summary
public PoolingHttpClientConnectionManager build()
createback to summary
public static PoolingHttpClientConnectionManagerBuilder create()
setConnectionConfigResolverback to summary
public final PoolingHttpClientConnectionManagerBuilder setConnectionConfigResolver(final Resolver<HttpRoute, ConnectionConfig> connectionConfigResolver)

Assigns Resolver of ConnectionConfig on a per route basis.

Since
5.2
setConnectionFactoryback to summary
public final PoolingHttpClientConnectionManagerBuilder setConnectionFactory(final HttpConnectionFactory<ManagedHttpClientConnection> connectionFactory)

Assigns HttpConnectionFactory instance.

setConnectionTimeToLiveback to summary
public final PoolingHttpClientConnectionManagerBuilder setConnectionTimeToLive(final TimeValue timeToLive)

Deprecated

Use setDefaultConnectionConfig(ConnectionConfig).

Sets maximum time to live for persistent connections

Annotations
@Deprecated
setConnPoolPolicyback to summary
public final PoolingHttpClientConnectionManagerBuilder setConnPoolPolicy(final PoolReusePolicy poolReusePolicy)

Assigns PoolReusePolicy value.

setDefaultConnectionConfigback to summary
public final PoolingHttpClientConnectionManagerBuilder setDefaultConnectionConfig(final ConnectionConfig config)

Assigns the same ConnectionConfig for all routes.

Since
5.2
setDefaultSocketConfigback to summary
public final PoolingHttpClientConnectionManagerBuilder setDefaultSocketConfig(final SocketConfig config)

Assigns the same SocketConfig for all routes.

setDefaultTlsConfigback to summary
public final PoolingHttpClientConnectionManagerBuilder setDefaultTlsConfig(final TlsConfig config)

Assigns the same TlsConfig for all hosts.

Since
5.2
setDnsResolverback to summary
public final PoolingHttpClientConnectionManagerBuilder setDnsResolver(final DnsResolver dnsResolver)

Assigns DnsResolver instance.

setMaxConnPerRouteback to summary
public final PoolingHttpClientConnectionManagerBuilder setMaxConnPerRoute(final int maxConnPerRoute)

Assigns maximum connection per route value.

setMaxConnTotalback to summary
public final PoolingHttpClientConnectionManagerBuilder setMaxConnTotal(final int maxConnTotal)

Assigns maximum total connection value.

setPoolConcurrencyPolicyback to summary
public final PoolingHttpClientConnectionManagerBuilder setPoolConcurrencyPolicy(final PoolConcurrencyPolicy poolConcurrencyPolicy)

Assigns PoolConcurrencyPolicy value.

setSchemePortResolverback to summary
public final PoolingHttpClientConnectionManagerBuilder setSchemePortResolver(final SchemePortResolver schemePortResolver)

Assigns SchemePortResolver instance.

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

Assigns Resolver of SocketConfig on a per route basis.

Since
5.2
setSSLSocketFactoryback to summary
public final PoolingHttpClientConnectionManagerBuilder setSSLSocketFactory(final LayeredConnectionSocketFactory sslSocketFactory)

Assigns LayeredConnectionSocketFactory instance.

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

Assigns Resolver of TlsConfig on a per host basis.

Since
5.2
setValidateAfterInactivityback to summary
public final PoolingHttpClientConnectionManagerBuilder setValidateAfterInactivity(final TimeValue validateAfterInactivity)

Deprecated

Use setDefaultConnectionConfig(ConnectionConfig).

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

Annotations
@Deprecated
useSystemPropertiesback to summary
public final PoolingHttpClientConnectionManagerBuilder useSystemProperties()

Use system properties when creating and configuring default implementations.