Package org.springframework.data.elasticsearch.client.reactive

Interface WebClientProvider

public interface WebClientProvider

Provider for WebClients using a pre-configured scheme. This class returns WebClient for a specific endpoint and encapsulates common configuration aspects of WebClient so that code using WebClient is not required to apply further configuration to the actual client.
Client instances are typically cached allowing reuse of pooled connections if configured on the ClientHttpConnector.

Since:

3.2

Author:

Christoph Strobl, Mark Paluch, Huw Ayling-Miller, Peter-Josef Meisch

Method Summary

Modifier and Type	Method	Description
static WebClientProvider	create(String scheme)	Creates a new WebClientProvider using the given scheme and a default ClientHttpConnector.
static WebClientProvider	create(String scheme, ClientHttpConnector connector)	Creates a new WebClientProvider given scheme and ClientHttpConnector.
WebClient	get(InetSocketAddress endpoint)	Obtain the WebClient configured with default HTTP headers and Consumer error callback for a given endpoint.
HttpHeaders	getDefaultHeaders()	Obtain the HttpHeaders to be used by default.
Consumer<Throwable>	getErrorListener()	Obtain the error listener to be used;
String	getPathPrefix()	Obtain the pathPrefix to be used.
static WebClientProvider	getWebClientProvider(ClientConfiguration clientConfiguration)	Creates a WebClientProvider for the given configuration
static WebClientProvider	http()	Creates a new WebClientProvider using the http scheme and a default ClientHttpConnector.
WebClientProvider	withDefaultHeaders(HttpHeaders headers)	Create a new instance of WebClientProvider applying the given headers by default.
WebClientProvider	withErrorListener(Consumer<Throwable> errorListener)	Create a new instance of WebClientProvider calling the given Consumer on error.
WebClientProvider	withPathPrefix(String pathPrefix)	Create a new instance of WebClientProvider where HTTP requests are called with the given path prefix.
WebClientProvider	withRequestConfigurer(Consumer<WebClient.RequestHeadersSpec<?>> requestConfigurer)	Create a new instance of WebClientProvider calling the given Consumer to configure the requests of this WebClient.
WebClientProvider	withWebClientConfigurer(Function<WebClient,WebClient> webClientConfigurer)	Create a new instance of WebClientProvider calling the given Function to configure the WebClient.

Method Details

http

static WebClientProvider http()

Creates a new WebClientProvider using the http scheme and a default ClientHttpConnector.

Returns:

the resulting WebClientProvider.

create

static WebClientProvider create(String scheme)

Creates a new WebClientProvider using the given scheme and a default ClientHttpConnector.

Parameters:

scheme - protocol scheme such as http or https.

Returns:

the resulting WebClientProvider.

create

static WebClientProvider create(String scheme,
 @Nullable
 ClientHttpConnector connector)

Creates a new WebClientProvider given scheme and ClientHttpConnector.

Parameters:

scheme - protocol scheme such as http or https.

connector - the HTTP connector to use. Can be null.

Returns:

the resulting WebClientProvider.

get

WebClient get(InetSocketAddress endpoint)

Obtain the WebClient configured with default HTTP headers and Consumer error callback for a given endpoint.

Returns:

the WebClient for the given endpoint.

getDefaultHeaders

HttpHeaders getDefaultHeaders()

Obtain the HttpHeaders to be used by default.

Returns:

never null. HttpHeaders.EMPTY by default.

getErrorListener

Consumer<Throwable> getErrorListener()

Obtain the error listener to be used;

Returns:

never null.

getPathPrefix

@Nullable
String getPathPrefix()

Obtain the pathPrefix to be used.

Returns:

the pathPrefix if set.

Since:

4.0

withDefaultHeaders

WebClientProvider withDefaultHeaders(HttpHeaders headers)

Create a new instance of WebClientProvider applying the given headers by default.

Parameters:

headers - must not be null.

Returns:

new instance of WebClientProvider.

withErrorListener

WebClientProvider withErrorListener(Consumer<Throwable> errorListener)

Create a new instance of WebClientProvider calling the given Consumer on error.

Parameters:

errorListener - must not be null.

Returns:

new instance of WebClientProvider.

withPathPrefix

WebClientProvider withPathPrefix(String pathPrefix)

Create a new instance of WebClientProvider where HTTP requests are called with the given path prefix.

Parameters:

pathPrefix - Path prefix to add to requests

Returns:

new instance of WebClientProvider

Since:

4.0

withWebClientConfigurer

WebClientProvider withWebClientConfigurer(Function<WebClient,WebClient> webClientConfigurer)

Create a new instance of WebClientProvider calling the given Function to configure the WebClient.

Parameters:

webClientConfigurer - configuration function

Returns:

new instance of WebClientProvider

Since:

4.0

withRequestConfigurer

WebClientProvider withRequestConfigurer(Consumer<WebClient.RequestHeadersSpec<?>> requestConfigurer)

Create a new instance of WebClientProvider calling the given Consumer to configure the requests of this WebClient.

Parameters:

requestConfigurer - request configuration callback

Returns:

new instance of WebClientProvider

Since:

4.3

getWebClientProvider

static WebClientProvider getWebClientProvider(ClientConfiguration clientConfiguration)

Creates a WebClientProvider for the given configuration

Parameters:

clientConfiguration - must not be null

Returns:

the WebClientProvider

Since:

4.3