Package org.springframework.boot.http.client.reactive

Interface ClientHttpConnectorBuilder<T extends ClientHttpConnector>

Type Parameters:

T - the ClientHttpConnector type

All Known Implementing Classes:

HttpComponentsClientHttpConnectorBuilder, JdkClientHttpConnectorBuilder, JettyClientHttpConnectorBuilder, ReactorClientHttpConnectorBuilder

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 ClientHttpConnectorBuilder<T extends ClientHttpConnector>

Interface used to build a fully configured ClientHttpConnector. Builders for Reactor, Jetty, Apache HTTP Components and JDK can be obtained using the factory methods on this interface. The of(Class) method may be used to instantiate based on the connector type.

Since:

3.5.0

Author:

Phillip Webb

Method Summary

Modifier and Type	Method	Description
default T	build()	Build a default configured ClientHttpConnectorBuilder.
T	build(ClientHttpConnectorSettings settings)	Build a fully configured ClientHttpConnector, applying the given settings if they are provided.
static ClientHttpConnectorBuilder<? extends ClientHttpConnector>	detect()	Detect the most suitable ClientHttpConnectorBuilder based on the classpath.
static ClientHttpConnectorBuilder<? extends ClientHttpConnector>	detect(ClassLoader classLoader)	Detect the most suitable ClientHttpConnectorBuilder based on the classpath.
static HttpComponentsClientHttpConnectorBuilder	httpComponents()	Return a HttpComponentsClientHttpConnectorBuilder that can be used to build a HttpComponentsClientHttpConnector.
static JdkClientHttpConnectorBuilder	jdk()	Return a JdkClientHttpConnectorBuilder that can be used to build a JdkClientHttpConnector .
static JettyClientHttpConnectorBuilder	jetty()	Return a JettyClientHttpConnectorBuilder that can be used to build a JettyClientHttpConnector.
static <T extends ClientHttpConnector> ClientHttpConnectorBuilder<T>	of(Class<T> clientHttpConnectorType)	Return a new ClientHttpConnectorBuilder for the given requestFactoryType.
static ReactorClientHttpConnectorBuilder	reactor()	Return a ReactorClientHttpConnectorBuilder that can be used to build a ReactorClientHttpConnector.
default ClientHttpConnectorBuilder<T>	withCustomizer(Consumer<T> customizer)	Return a new ClientHttpConnectorBuilder that applies the given customizer to the ClientHttpConnector after it has been built.
default ClientHttpConnectorBuilder<T>	withCustomizers(Collection<Consumer<T>> customizers)	Return a new ClientHttpConnectorBuilder that applies the given customizers to the ClientHttpConnector after it has been built.

Method Details

build

default T build()

Build a default configured ClientHttpConnectorBuilder.

Returns:

a default configured ClientHttpConnectorBuilder.

build

T build(ClientHttpConnectorSettings settings)

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

Parameters:

settings - the settings to apply or null

Returns:

a fully configured ClientHttpConnector.

withCustomizer

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

Return a new ClientHttpConnectorBuilder that applies the given customizer to the ClientHttpConnector after it has been built.

Parameters:

customizer - the customizers to apply

Returns:

a new ClientHttpConnectorBuilder instance

withCustomizers

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

Return a new ClientHttpConnectorBuilder that applies the given customizers to the ClientHttpConnector after it has been built.

Parameters:

customizers - the customizers to apply

Returns:

a new ClientHttpConnectorBuilder instance

httpComponents

static HttpComponentsClientHttpConnectorBuilder httpComponents()

Return a HttpComponentsClientHttpConnectorBuilder that can be used to build a HttpComponentsClientHttpConnector.

Returns:

a new HttpComponentsClientHttpConnectorBuilder

jetty

static JettyClientHttpConnectorBuilder jetty()

Return a JettyClientHttpConnectorBuilder that can be used to build a JettyClientHttpConnector.

Returns:

a new JettyClientHttpConnectorBuilder

reactor

static ReactorClientHttpConnectorBuilder reactor()

Return a ReactorClientHttpConnectorBuilder that can be used to build a ReactorClientHttpConnector.

Returns:

a new ReactorClientHttpConnectorBuilder

jdk

static JdkClientHttpConnectorBuilder jdk()

Return a JdkClientHttpConnectorBuilder that can be used to build a JdkClientHttpConnector .

Returns:

a new JdkClientHttpConnectorBuilder

of

static <T extends ClientHttpConnector>
ClientHttpConnectorBuilder<T> of(Class<T> clientHttpConnectorType)

Return a new ClientHttpConnectorBuilder for the given requestFactoryType. The following implementations are supported:

• ReactorClientHttpConnector
• JettyClientHttpConnector
• HttpComponentsClientHttpConnector
• JdkClientHttpConnector

Type Parameters:

T - the ClientHttpConnector type

Parameters:

clientHttpConnectorType - the ClientHttpConnector type

Returns:

a new ClientHttpConnectorBuilder

detect

static ClientHttpConnectorBuilder<? extends ClientHttpConnector> detect()

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

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

Returns:

the most suitable ClientHttpConnectorBuilder for the classpath

detect

static ClientHttpConnectorBuilder<? extends ClientHttpConnector> detect(ClassLoader classLoader)

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

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

Parameters:

classLoader - the class loader to use for detection

Returns:

the most suitable ClientHttpConnectorBuilder for the classpath