public class HttpClientBuilder extends Object
HttpClient
instances.
Among other things,
Constructor and Description |
---|
HttpClientBuilder(Environment environment) |
HttpClientBuilder(com.codahale.metrics.MetricRegistry metricRegistry) |
Modifier and Type | Method and Description |
---|---|
org.apache.http.impl.client.CloseableHttpClient |
build(String name)
Builds the
HttpClient . |
protected com.codahale.metrics.httpclient.InstrumentedHttpClientConnectionManager |
configureConnectionManager(com.codahale.metrics.httpclient.InstrumentedHttpClientConnectionManager connectionManager) |
protected org.apache.http.auth.Credentials |
configureCredentials(AuthConfiguration auth)
determine the Credentials implementation to use
|
protected org.apache.http.impl.client.HttpClientBuilder |
createBuilder()
Creates an Apache
HttpClientBuilder . |
protected ConfiguredCloseableHttpClient |
createClient(org.apache.http.impl.client.HttpClientBuilder builder,
com.codahale.metrics.httpclient.InstrumentedHttpClientConnectionManager manager,
String name)
Map the parameters in
HttpClientConfiguration to configuration on a
HttpClientBuilder instance |
protected com.codahale.metrics.httpclient.InstrumentedHttpClientConnectionManager |
createConnectionManager(org.apache.http.config.Registry<org.apache.http.conn.socket.ConnectionSocketFactory> registry,
String name)
Create a InstrumentedHttpClientConnectionManager based on the
HttpClientConfiguration.
|
protected org.apache.http.protocol.HttpRequestExecutor |
createRequestExecutor(String name)
Creates a
HttpRequestExecutor . |
protected String |
createUserAgent(String name)
Create a user agent string using the configured user agent if defined, otherwise
using a combination of the environment name and this client name
|
protected org.apache.http.impl.client.HttpClientBuilder |
customizeBuilder(org.apache.http.impl.client.HttpClientBuilder builder)
Configures an Apache
HttpClientBuilder . |
HttpClientBuilder |
disableContentCompression(boolean disableContentCompression)
Disable support of decompression of responses
|
HttpClientBuilder |
name(String environmentName)
Use the given environment name.
|
HttpClientBuilder |
using(org.apache.http.client.CredentialsProvider credentialsProvider)
Use the given
CredentialsProvider instance. |
HttpClientBuilder |
using(org.apache.http.conn.DnsResolver resolver)
Use the given
DnsResolver instance. |
HttpClientBuilder |
using(HostnameVerifier verifier)
Use the give (@link HostnameVerifier} instance.
|
HttpClientBuilder |
using(HttpClientConfiguration configuration)
Use the given
HttpClientConfiguration instance. |
HttpClientBuilder |
using(com.codahale.metrics.httpclient.HttpClientMetricNameStrategy metricNameStrategy)
Use the given
HttpClientMetricNameStrategy instance. |
HttpClientBuilder |
using(org.apache.http.protocol.HttpProcessor httpProcessor)
Use the given
HttpProcessor instance |
HttpClientBuilder |
using(org.apache.http.client.HttpRequestRetryHandler httpRequestRetryHandler)
Uses the
HttpRequestRetryHandler for handling request retries. |
HttpClientBuilder |
using(org.apache.http.conn.routing.HttpRoutePlanner routePlanner)
Use the given
HttpRoutePlanner instance. |
HttpClientBuilder |
using(List<? extends org.apache.http.Header> defaultHeaders)
Use the given default headers for each HTTP request
|
HttpClientBuilder |
using(org.apache.http.client.RedirectStrategy redirectStrategy)
Use the given
RedirectStrategy instance. |
HttpClientBuilder |
using(org.apache.http.config.Registry<org.apache.http.conn.socket.ConnectionSocketFactory> registry)
Use the given
Registry instance. |
HttpClientBuilder |
using(org.apache.http.client.ServiceUnavailableRetryStrategy serviceUnavailableRetryStrategy)
Use the given
ServiceUnavailableRetryStrategy instance |
public HttpClientBuilder(com.codahale.metrics.MetricRegistry metricRegistry)
public HttpClientBuilder(Environment environment)
public HttpClientBuilder name(String environmentName)
environmentName
- an environment name to use in the user agent.this
public HttpClientBuilder using(HttpClientConfiguration configuration)
HttpClientConfiguration
instance.configuration
- a HttpClientConfiguration
instancethis
public HttpClientBuilder using(org.apache.http.conn.DnsResolver resolver)
DnsResolver
instance.resolver
- a DnsResolver
instancethis
public HttpClientBuilder using(HostnameVerifier verifier)
verifier
- a HostnameVerifier
instancethis
public HttpClientBuilder using(org.apache.http.client.HttpRequestRetryHandler httpRequestRetryHandler)
HttpRequestRetryHandler
for handling request retries.httpRequestRetryHandler
- an httpRequestRetryHandlerthis
public HttpClientBuilder using(org.apache.http.config.Registry<org.apache.http.conn.socket.ConnectionSocketFactory> registry)
Registry
instance.registry
- this
public HttpClientBuilder using(org.apache.http.conn.routing.HttpRoutePlanner routePlanner)
HttpRoutePlanner
instance.routePlanner
- a HttpRoutePlanner
instancethis
public HttpClientBuilder using(org.apache.http.client.CredentialsProvider credentialsProvider)
CredentialsProvider
instance.credentialsProvider
- a CredentialsProvider
instancethis
public HttpClientBuilder using(com.codahale.metrics.httpclient.HttpClientMetricNameStrategy metricNameStrategy)
HttpClientMetricNameStrategy
instance.metricNameStrategy
- a HttpClientMetricNameStrategy
instancethis
public HttpClientBuilder using(org.apache.http.client.RedirectStrategy redirectStrategy)
RedirectStrategy
instance.redirectStrategy
- a RedirectStrategy
instancethis
public HttpClientBuilder using(List<? extends org.apache.http.Header> defaultHeaders)
defaultHeaders
- HTTP headerspublic HttpClientBuilder using(org.apache.http.protocol.HttpProcessor httpProcessor)
HttpProcessor
instancehttpProcessor
- a HttpProcessor
instancepublic HttpClientBuilder using(org.apache.http.client.ServiceUnavailableRetryStrategy serviceUnavailableRetryStrategy)
ServiceUnavailableRetryStrategy
instanceserviceUnavailableRetryStrategy
- a ServiceUnavailableRetryStrategy
instancepublic HttpClientBuilder disableContentCompression(boolean disableContentCompression)
disableContentCompression
- true
, if disabledthis
public org.apache.http.impl.client.CloseableHttpClient build(String name)
HttpClient
.name
- CloseableHttpClient
protected org.apache.http.protocol.HttpRequestExecutor createRequestExecutor(String name)
HttpRequestExecutor
.
Intended for use by subclasses to provide a customized request executor.
The default implementation is an InstrumentedHttpRequestExecutor
name
- HttpRequestExecutor
protected org.apache.http.impl.client.HttpClientBuilder createBuilder()
HttpClientBuilder
.
Intended for use by subclasses to create builder instance from subclass of
HttpClientBuilder
HttpClientBuilder
protected org.apache.http.impl.client.HttpClientBuilder customizeBuilder(org.apache.http.impl.client.HttpClientBuilder builder)
HttpClientBuilder
.
Intended for use by subclasses to inject HttpClientBuilder
configuration. The default implementation is an identity
function.protected ConfiguredCloseableHttpClient createClient(org.apache.http.impl.client.HttpClientBuilder builder, com.codahale.metrics.httpclient.InstrumentedHttpClientConnectionManager manager, String name)
HttpClientConfiguration
to configuration on a
HttpClientBuilder
instancebuilder
- manager
- name
- CloseableHttpClient
protected String createUserAgent(String name)
name
- the name of this clientprotected com.codahale.metrics.httpclient.InstrumentedHttpClientConnectionManager createConnectionManager(org.apache.http.config.Registry<org.apache.http.conn.socket.ConnectionSocketFactory> registry, String name)
registry
- name
- protected com.codahale.metrics.httpclient.InstrumentedHttpClientConnectionManager configureConnectionManager(com.codahale.metrics.httpclient.InstrumentedHttpClientConnectionManager connectionManager)
protected org.apache.http.auth.Credentials configureCredentials(AuthConfiguration auth)
auth
- Credentials
instance, either {UsernamePasswordCredentials
or NTCredentials
}Copyright © 2020. All rights reserved.