Package org.springframework.boot.http.client

Class HttpComponentsHttpAsyncClientBuilder

java.lang.Object

org.springframework.boot.http.client.HttpComponentsHttpAsyncClientBuilder

public final class HttpComponentsHttpAsyncClientBuilder
extends Object

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

Since:

3.5.0

Author:

Phillip Webb, Andy Wilkinson, Scott Frederick

Constructor Summary

Constructors

Constructor	Description
HttpComponentsHttpAsyncClientBuilder()

Method Summary

Modifier and Type	Method	Description
org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient	build(HttpClientSettings settings)	Build a new HttpAsyncClient instance with the given settings applied.
HttpComponentsHttpAsyncClientBuilder	withConnectionConfigCustomizer(Consumer<org.apache.hc.client5.http.config.ConnectionConfig.Builder> connectionConfigCustomizer)	Return a new HttpComponentsHttpAsyncClientBuilder that applies additional customization to the underlying ConnectionConfig.Builder.
HttpComponentsHttpAsyncClientBuilder	withConnectionManagerCustomizer(Consumer<org.apache.hc.client5.http.impl.nio.PoolingAsyncClientConnectionManagerBuilder> connectionManagerCustomizer)	Return a new HttpComponentsHttpAsyncClientBuilder that applies additional customization to the underlying PoolingAsyncClientConnectionManagerBuilder.
HttpComponentsHttpAsyncClientBuilder	withCustomizer(Consumer<org.apache.hc.client5.http.impl.async.HttpAsyncClientBuilder> customizer)	Return a new HttpComponentsHttpAsyncClientBuilder that applies additional customization to the underlying HttpAsyncClientBuilder.
HttpComponentsHttpAsyncClientBuilder	withDefaultRequestConfigCustomizer(Consumer<org.apache.hc.client5.http.config.RequestConfig.Builder> defaultRequestConfigCustomizer)	Return a new HttpComponentsHttpAsyncClientBuilder that applies additional customization to the underlying RequestConfig.Builder used for default requests.
HttpComponentsHttpAsyncClientBuilder	withTlsStrategyFactory(Function<SslBundle,org.apache.hc.core5.http.nio.ssl.TlsStrategy> tlsStrategyFactory)	Return a new HttpComponentsHttpAsyncClientBuilder with a replacement TlsStrategy factory.

Methods inherited from class java.lang.Object

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

Constructor Details

HttpComponentsHttpAsyncClientBuilder

public HttpComponentsHttpAsyncClientBuilder()

Method Details

withCustomizer

public HttpComponentsHttpAsyncClientBuilder withCustomizer(Consumer<org.apache.hc.client5.http.impl.async.HttpAsyncClientBuilder> customizer)

Return a new HttpComponentsHttpAsyncClientBuilder that applies additional customization to the underlying HttpAsyncClientBuilder.

Parameters:

customizer - the customizer to apply

Returns:

a new HttpComponentsHttpAsyncClientBuilder instance

withConnectionManagerCustomizer

public HttpComponentsHttpAsyncClientBuilder withConnectionManagerCustomizer(Consumer<org.apache.hc.client5.http.impl.nio.PoolingAsyncClientConnectionManagerBuilder> connectionManagerCustomizer)

Return a new HttpComponentsHttpAsyncClientBuilder that applies additional customization to the underlying PoolingAsyncClientConnectionManagerBuilder.

Parameters:

connectionManagerCustomizer - the customizer to apply

Returns:

a new HttpComponentsHttpAsyncClientBuilder instance

withConnectionConfigCustomizer

public HttpComponentsHttpAsyncClientBuilder withConnectionConfigCustomizer(Consumer<org.apache.hc.client5.http.config.ConnectionConfig.Builder> connectionConfigCustomizer)

Return a new HttpComponentsHttpAsyncClientBuilder that applies additional customization to the underlying ConnectionConfig.Builder.

Parameters:

connectionConfigCustomizer - the customizer to apply

Returns:

a new HttpComponentsHttpAsyncClientBuilder instance

withTlsStrategyFactory

public HttpComponentsHttpAsyncClientBuilder withTlsStrategyFactory(Function<SslBundle,org.apache.hc.core5.http.nio.ssl.TlsStrategy> tlsStrategyFactory)

Return a new HttpComponentsHttpAsyncClientBuilder with a replacement TlsStrategy factory.

Parameters:

tlsStrategyFactory - the new factory used to create a TlsStrategy for a given SslBundle

Returns:

a new HttpComponentsHttpAsyncClientBuilder instance

withDefaultRequestConfigCustomizer

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

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

Parameters:

defaultRequestConfigCustomizer - the customizer to apply

Returns:

a new HttpComponentsHttpAsyncClientBuilder instance

build

public org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient build(HttpClientSettings settings)

Build a new HttpAsyncClient instance with the given settings applied.

Parameters:

settings - the settings to apply

Returns:

a new CloseableHttpAsyncClient instance