Package org.springframework.boot.http.client

Interface ClientHttpRequestFactoryBuilder<T extends ClientHttpRequestFactory>

Type Parameters:

T - the ClientHttpRequestFactory type

All Known Implementing Classes:

HttpComponentsClientHttpRequestFactoryBuilder, JdkClientHttpRequestFactoryBuilder, JettyClientHttpRequestFactoryBuilder, ReactorClientHttpRequestFactoryBuilder, SimpleClientHttpRequestFactoryBuilder

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ClientHttpRequestFactoryBuilder<T extends ClientHttpRequestFactory>

Interface used to build a fully configured ClientHttpRequestFactory. Builders for Apache HTTP Components, Jetty, Reactor, JDK and simple client can be obtained using the factory methods on this interface. The of(Class) and of(Supplier) methods may be used to instantiate other ClientHttpRequestFactory instances using reflection.

Since:

3.4.0

Author:

Phillip Webb

Method Summary

Modifier and Type	Method	Description
default T	build()	Build a default configured ClientHttpRequestFactory.
T	build(ClientHttpRequestFactorySettings settings)	Build a fully configured ClientHttpRequestFactory, applying the given settings if they are provided.
static ClientHttpRequestFactoryBuilder<? extends ClientHttpRequestFactory>	detect()	Detect the most suitable ClientHttpRequestFactoryBuilder based on the classpath.
static HttpComponentsClientHttpRequestFactoryBuilder	httpComponents()	Return a HttpComponentsClientHttpRequestFactoryBuilder that can be used to build a HttpComponentsClientHttpRequestFactory.
static JdkClientHttpRequestFactoryBuilder	jdk()	Return a JdkClientHttpRequestFactoryBuilder that can be used to build a JdkClientHttpRequestFactory .
static JettyClientHttpRequestFactoryBuilder	jetty()	Return a JettyClientHttpRequestFactoryBuilder that can be used to build a JettyClientHttpRequestFactory.
static <T extends ClientHttpRequestFactory> ClientHttpRequestFactoryBuilder<T>	of(Class<T> requestFactoryType)	Return a new ClientHttpRequestFactoryBuilder for the given requestFactoryType.
static <T extends ClientHttpRequestFactory> ClientHttpRequestFactoryBuilder<T>	of(Supplier<T> requestFactorySupplier)	Return a new ClientHttpRequestFactoryBuilder from the given supplier, using reflection to ultimately apply the ClientHttpRequestFactorySettings.
static ReactorClientHttpRequestFactoryBuilder	reactor()	Return a ReactorClientHttpRequestFactoryBuilder that can be used to build a ReactorClientHttpRequestFactory.
static SimpleClientHttpRequestFactoryBuilder	simple()	Return a SimpleClientHttpRequestFactoryBuilder that can be used to build a SimpleClientHttpRequestFactory .
default ClientHttpRequestFactoryBuilder<T>	withCustomizer(Consumer<T> customizer)	Return a new ClientHttpRequestFactoryBuilder that applies the given customizer to the ClientHttpRequestFactory after it has been built.
default ClientHttpRequestFactoryBuilder<T>	withCustomizers(Collection<Consumer<T>> customizers)	Return a new ClientHttpRequestFactoryBuilder that applies the given customizers to the ClientHttpRequestFactory after it has been built.

Method Details

build

default T build()

Build a default configured ClientHttpRequestFactory.

Returns:

a default configured ClientHttpRequestFactory.

build

T build(ClientHttpRequestFactorySettings settings)

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

Parameters:

settings - the settings to apply or null

Returns:

a fully configured ClientHttpRequestFactory.

withCustomizer

default ClientHttpRequestFactoryBuilder<T> withCustomizer(Consumer<T> customizer)

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

default ClientHttpRequestFactoryBuilder<T> withCustomizers(Collection<Consumer<T>> customizers)

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

httpComponents

static HttpComponentsClientHttpRequestFactoryBuilder httpComponents()

Return a HttpComponentsClientHttpRequestFactoryBuilder that can be used to build a HttpComponentsClientHttpRequestFactory.

Returns:

a new HttpComponentsClientHttpRequestFactoryBuilder

jetty

static JettyClientHttpRequestFactoryBuilder jetty()

Return a JettyClientHttpRequestFactoryBuilder that can be used to build a JettyClientHttpRequestFactory.

Returns:

a new JettyClientHttpRequestFactoryBuilder

reactor

static ReactorClientHttpRequestFactoryBuilder reactor()

Return a ReactorClientHttpRequestFactoryBuilder that can be used to build a ReactorClientHttpRequestFactory.

Returns:

a new ReactorClientHttpRequestFactoryBuilder

jdk

static JdkClientHttpRequestFactoryBuilder jdk()

Return a JdkClientHttpRequestFactoryBuilder that can be used to build a JdkClientHttpRequestFactory .

Returns:

a new JdkClientHttpRequestFactoryBuilder

simple

static SimpleClientHttpRequestFactoryBuilder simple()

Return a SimpleClientHttpRequestFactoryBuilder that can be used to build a SimpleClientHttpRequestFactory .

Returns:

a new SimpleClientHttpRequestFactoryBuilder

of

static <T extends ClientHttpRequestFactory>
ClientHttpRequestFactoryBuilder<T> of(Class<T> requestFactoryType)

Return a new ClientHttpRequestFactoryBuilder for the given requestFactoryType. The following implementations are supported without the use of reflection:

• HttpComponentsClientHttpRequestFactory
• JdkClientHttpRequestFactory
• JettyClientHttpRequestFactory
• ReactorClientHttpRequestFactory
• SimpleClientHttpRequestFactory

Type Parameters:

T - the ClientHttpRequestFactory type

Parameters:

requestFactoryType - the ClientHttpRequestFactory type

Returns:

a new ClientHttpRequestFactoryBuilder

of

static <T extends ClientHttpRequestFactory>
ClientHttpRequestFactoryBuilder<T> of(Supplier<T> requestFactorySupplier)

Return a new ClientHttpRequestFactoryBuilder from the given supplier, using reflection to ultimately apply the ClientHttpRequestFactorySettings.

Type Parameters:

T - the ClientHttpRequestFactory type

Parameters:

requestFactorySupplier - the ClientHttpRequestFactory supplier

Returns:

a new ClientHttpRequestFactoryBuilder

detect

static ClientHttpRequestFactoryBuilder<? extends ClientHttpRequestFactory> detect()

Detect the most suitable ClientHttpRequestFactoryBuilder based on the classpath. The methods favors builders in the following order:

1. httpComponents()
2. jetty()
3. reactor()
4. jdk()
5. simple()

Returns:

the most suitable ClientHttpRequestFactoryBuilder for the classpath