Package org.springframework.boot.http.client

Class HttpComponentsClientHttpRequestFactoryBuilder

java.lang.Object

org.springframework.boot.http.client.HttpComponentsClientHttpRequestFactoryBuilder

All Implemented Interfaces:

ClientHttpRequestFactoryBuilder<HttpComponentsClientHttpRequestFactory>

public final class HttpComponentsClientHttpRequestFactoryBuilder
extends Object

Builder for ClientHttpRequestFactoryBuilder.httpComponents().

Since:

3.4.0

Author:

Phillip Webb, Andy Wilkinson, Scott Frederick

Method Summary

Modifier and Type	Method	Description
final HttpComponentsClientHttpRequestFactory	build(ClientHttpRequestFactorySettings settings)	Build a fully configured ClientHttpRequestFactory, applying the given settings if they are provided.
protected HttpComponentsClientHttpRequestFactory	createClientHttpRequestFactory(ClientHttpRequestFactorySettings settings)
protected static <T> Consumer<T>	emptyCustomizer()
protected final List<Consumer<HttpComponentsClientHttpRequestFactory>>	getCustomizers()
protected final List<Consumer<HttpComponentsClientHttpRequestFactory>>	mergedCustomizers(Collection<Consumer<HttpComponentsClientHttpRequestFactory>> customizers)
protected final List<Consumer<HttpComponentsClientHttpRequestFactory>>	mergedCustomizers(Consumer<HttpComponentsClientHttpRequestFactory> customizer)
HttpComponentsClientHttpRequestFactoryBuilder	withConnectionManagerCustomizer(Consumer<org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManagerBuilder> connectionManagerCustomizer)	Return a new HttpComponentsClientHttpRequestFactoryBuilder that applies additional customization to the underlying PoolingHttpClientConnectionManagerBuilder.
HttpComponentsClientHttpRequestFactoryBuilder	withCustomizer(Consumer<HttpComponentsClientHttpRequestFactory> customizer)	Return a new ClientHttpRequestFactoryBuilder that applies the given customizer to the ClientHttpRequestFactory after it has been built.
HttpComponentsClientHttpRequestFactoryBuilder	withCustomizers(Collection<Consumer<HttpComponentsClientHttpRequestFactory>> customizers)	Return a new ClientHttpRequestFactoryBuilder that applies the given customizers to the ClientHttpRequestFactory after it has been built.
HttpComponentsClientHttpRequestFactoryBuilder	withDefaultRequestConfigCustomizer(Consumer<org.apache.hc.client5.http.config.RequestConfig.Builder> defaultRequestConfigCustomizer)	Return a new HttpComponentsClientHttpRequestFactoryBuilder that applies additional customization to the underlying RequestConfig.Builder used for default requests.
HttpComponentsClientHttpRequestFactoryBuilder	withHttpClientCustomizer(Consumer<org.apache.hc.client5.http.impl.classic.HttpClientBuilder> httpClientCustomizer)	Return a new HttpComponentsClientHttpRequestFactoryBuilder that applies additional customization to the underlying HttpClientBuilder.
HttpComponentsClientHttpRequestFactoryBuilder	withSocketConfigCustomizer(Consumer<org.apache.hc.core5.http.io.SocketConfig.Builder> socketConfigCustomizer)	Return a new HttpComponentsClientHttpRequestFactoryBuilder that applies additional customization to the underlying SocketConfig.Builder.
HttpComponentsClientHttpRequestFactoryBuilder	withTlsSocketStrategyFactory(Function<SslBundle,org.apache.hc.client5.http.ssl.TlsSocketStrategy> tlsSocketStrategyFactory)	Return a new HttpComponentsClientHttpRequestFactoryBuilder with a replacement TlsSocketStrategy factory.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.boot.http.client.ClientHttpRequestFactoryBuilder

build

Method Details

withCustomizer

public HttpComponentsClientHttpRequestFactoryBuilder withCustomizer(Consumer<HttpComponentsClientHttpRequestFactory> customizer)

Description copied from interface: ClientHttpRequestFactoryBuilder

Return a new ClientHttpRequestFactoryBuilder that applies the given customizer to the ClientHttpRequestFactory after it has been built.

Parameters:

customizer - the customizers to apply

Returns:

a new ClientHttpRequestFactoryBuilder instance

withCustomizers

public HttpComponentsClientHttpRequestFactoryBuilder withCustomizers(Collection<Consumer<HttpComponentsClientHttpRequestFactory>> customizers)

Description copied from interface: ClientHttpRequestFactoryBuilder

Return a new ClientHttpRequestFactoryBuilder that applies the given customizers to the ClientHttpRequestFactory after it has been built.

Parameters:

customizers - the customizers to apply

Returns:

a new ClientHttpRequestFactoryBuilder instance

withHttpClientCustomizer

public HttpComponentsClientHttpRequestFactoryBuilder withHttpClientCustomizer(Consumer<org.apache.hc.client5.http.impl.classic.HttpClientBuilder> httpClientCustomizer)

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

Parameters:

httpClientCustomizer - the customizer to apply

Returns:

a new HttpComponentsClientHttpRequestFactoryBuilder instance

withConnectionManagerCustomizer

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

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

Parameters:

connectionManagerCustomizer - the customizer to apply

Returns:

a new HttpComponentsClientHttpRequestFactoryBuilder instance

withSocketConfigCustomizer

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

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

Parameters:

socketConfigCustomizer - the customizer to apply

Returns:

a new HttpComponentsClientHttpRequestFactoryBuilder instance

withTlsSocketStrategyFactory

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

Return a new HttpComponentsClientHttpRequestFactoryBuilder with a replacement TlsSocketStrategy factory.

Parameters:

tlsSocketStrategyFactory - the new factory used to create a TlsSocketStrategy for a given SslBundle

Returns:

a new HttpComponentsClientHttpRequestFactoryBuilder instance

withDefaultRequestConfigCustomizer

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

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

Parameters:

defaultRequestConfigCustomizer - the customizer to apply

Returns:

a new HttpComponentsClientHttpRequestFactoryBuilder instance

createClientHttpRequestFactory

protected HttpComponentsClientHttpRequestFactory createClientHttpRequestFactory(ClientHttpRequestFactorySettings settings)

emptyCustomizer

protected static <T> Consumer<T> emptyCustomizer()

getCustomizers

protected final List<Consumer<HttpComponentsClientHttpRequestFactory>> getCustomizers()

mergedCustomizers

protected final List<Consumer<HttpComponentsClientHttpRequestFactory>> mergedCustomizers(Consumer<HttpComponentsClientHttpRequestFactory> customizer)

mergedCustomizers

protected final List<Consumer<HttpComponentsClientHttpRequestFactory>> mergedCustomizers(Collection<Consumer<HttpComponentsClientHttpRequestFactory>> customizers)

build

public final HttpComponentsClientHttpRequestFactory build(ClientHttpRequestFactorySettings settings)

Description copied from interface: ClientHttpRequestFactoryBuilder

Build a fully configured ClientHttpRequestFactory, applying the given settings if they are provided.

Specified by:

build in interface ClientHttpRequestFactoryBuilder<T extends ClientHttpRequestFactory>

Parameters:

settings - the settings to apply or null

Returns:

a fully configured ClientHttpRequestFactory.