Package org.springframework.boot.http.client

Class HttpComponentsHttpClientBuilder

java.lang.Object

org.springframework.boot.http.client.HttpComponentsHttpClientBuilder

public final class HttpComponentsHttpClientBuilder
extends Object

Builder that can be used to create a Apache HttpComponents HttpClient.

Since:

3.5.0

Author:

Phillip Webb, Andy Wilkinson, Scott Frederick

Constructor Summary

Constructors

Constructor	Description
HttpComponentsHttpClientBuilder()

Method Summary

Modifier and Type	Method	Description
org.apache.hc.client5.http.impl.classic.CloseableHttpClient	build(HttpClientSettings settings)	Build a new HttpClient instance with the given settings applied.
HttpComponentsHttpClientBuilder	withConnectionManagerCustomizer(Consumer<org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManagerBuilder> connectionManagerCustomizer)	Return a new HttpComponentsHttpClientBuilder that applies additional customization to the underlying PoolingHttpClientConnectionManagerBuilder.
HttpComponentsHttpClientBuilder	withCustomizer(Consumer<org.apache.hc.client5.http.impl.classic.HttpClientBuilder> customizer)	Return a new HttpComponentsHttpClientBuilder that applies additional customization to the underlying HttpClientBuilder.
HttpComponentsHttpClientBuilder	withDefaultRequestConfigCustomizer(Consumer<org.apache.hc.client5.http.config.RequestConfig.Builder> defaultRequestConfigCustomizer)	Return a new HttpComponentsHttpClientBuilder that applies additional customization to the underlying RequestConfig.Builder used for default requests.
HttpComponentsHttpClientBuilder	withSocketConfigCustomizer(Consumer<org.apache.hc.core5.http.io.SocketConfig.Builder> socketConfigCustomizer)	Return a new HttpComponentsHttpClientBuilder that applies additional customization to the underlying SocketConfig.Builder.
HttpComponentsHttpClientBuilder	withTlsSocketStrategyFactory(Function<SslBundle,org.apache.hc.client5.http.ssl.TlsSocketStrategy> tlsSocketStrategyFactory)	Return a new HttpComponentsHttpClientBuilder with a replacement TlsSocketStrategy factory.

Methods inherited from class java.lang.Object

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

Constructor Details

HttpComponentsHttpClientBuilder

public HttpComponentsHttpClientBuilder()

Method Details

withCustomizer

public HttpComponentsHttpClientBuilder withCustomizer(Consumer<org.apache.hc.client5.http.impl.classic.HttpClientBuilder> customizer)

Return a new HttpComponentsHttpClientBuilder that applies additional customization to the underlying HttpClientBuilder.

Parameters:

customizer - the customizer to apply

Returns:

a new HttpComponentsHttpClientBuilder instance

withConnectionManagerCustomizer

public HttpComponentsHttpClientBuilder withConnectionManagerCustomizer(Consumer<org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManagerBuilder> connectionManagerCustomizer)

Return a new HttpComponentsHttpClientBuilder that applies additional customization to the underlying PoolingHttpClientConnectionManagerBuilder.

Parameters:

connectionManagerCustomizer - the customizer to apply

Returns:

a new HttpComponentsHttpClientBuilder instance

withSocketConfigCustomizer

public HttpComponentsHttpClientBuilder withSocketConfigCustomizer(Consumer<org.apache.hc.core5.http.io.SocketConfig.Builder> socketConfigCustomizer)

Return a new HttpComponentsHttpClientBuilder that applies additional customization to the underlying SocketConfig.Builder.

Parameters:

socketConfigCustomizer - the customizer to apply

Returns:

a new HttpComponentsHttpClientBuilder instance

withTlsSocketStrategyFactory

public HttpComponentsHttpClientBuilder withTlsSocketStrategyFactory(Function<SslBundle,org.apache.hc.client5.http.ssl.TlsSocketStrategy> tlsSocketStrategyFactory)

Return a new HttpComponentsHttpClientBuilder with a replacement TlsSocketStrategy factory.

Parameters:

tlsSocketStrategyFactory - the new factory used to create a TlsSocketStrategy. The function will be provided with a SslBundle or null if no bundle is selected. Only non null results will be applied.

Returns:

a new HttpComponentsHttpClientBuilder instance

withDefaultRequestConfigCustomizer

public HttpComponentsHttpClientBuilder withDefaultRequestConfigCustomizer(Consumer<org.apache.hc.client5.http.config.RequestConfig.Builder> defaultRequestConfigCustomizer)

Return a new HttpComponentsHttpClientBuilder that applies additional customization to the underlying RequestConfig.Builder used for default requests.

Parameters:

defaultRequestConfigCustomizer - the customizer to apply

Returns:

a new HttpComponentsHttpClientBuilder instance

build

public org.apache.hc.client5.http.impl.classic.CloseableHttpClient build(HttpClientSettings settings)

Build a new HttpClient instance with the given settings applied.

Parameters:

settings - the settings to apply

Returns:

a new HttpClient instance