org.springframework.vault.client

Class WebClientBuilder

java.lang.Object

org.springframework.vault.client.WebClientBuilder

public class WebClientBuilder
extends Object

Builder that can be used to configure and create a WebClient. Provides convenience methods to configure ClientHttpConnector and default headers. By default the built WebClient will attempt to use the most suitable ClientHttpConnector using ClientHttpConnectorFactory.create(org.springframework.vault.support.ClientOptions, org.springframework.vault.support.SslConfiguration).

Since:

2.2

Author:

Mark Paluch

See Also:

ClientHttpConnectorFactory, WebClientCustomizer

Method Summary

Modifier and Type	Method and Description
WebClient	build() Build a new WebClient.
static WebClientBuilder	builder() Create a new WebClientBuilder.
protected WebClient.Builder	createWebClientBuilder() Create the WebClient.Builder to use.
WebClientBuilder	customizers(WebClientCustomizer... customizer) Add the WebClientCustomizers that should be applied to the WebClient.
WebClientBuilder	defaultHeader(String name, String value) Add a default header that will be set if not already present on the outgoing HttpRequest.
WebClientBuilder	endpoint(VaultEndpoint endpoint) Set the VaultEndpoint that should be used with the WebClient.
WebClientBuilder	endpointProvider(ReactiveVaultEndpointProvider provider) Set the ReactiveVaultEndpointProvider that should be used with the WebClient.
WebClientBuilder	endpointProvider(VaultEndpointProvider provider) Set the VaultEndpointProvider that should be used with the WebClient.
WebClientBuilder	filter(ExchangeFilterFunction... filterFunctions) Add the ExchangeFilterFunctions that should be applied to the ClientRequest.
WebClientBuilder	httpConnector(ClientHttpConnector httpConnector) Set the ClientHttpConnector that should be used with the WebClient.
WebClientBuilder	httpConnectorFactory(Supplier<ClientHttpConnector> httpConnector) Set the Supplier of ClientHttpConnector that should be called each time we build() a new WebClient instance.
WebClientBuilder	requestFactory(Supplier<ClientHttpConnector> httpConnector) Deprecated. since 2.2.1 as the name is wrong, use httpConnectorFactory(Supplier)

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static WebClientBuilder builder()

Create a new WebClientBuilder.

Returns:

a new WebClientBuilder.

endpoint

public WebClientBuilder endpoint(VaultEndpoint endpoint)

Set the VaultEndpoint that should be used with the WebClient.

Parameters:

endpoint - the VaultEndpoint provider.

Returns:

this WebClientBuilder.

endpointProvider

public WebClientBuilder endpointProvider(VaultEndpointProvider provider)

Set the VaultEndpointProvider that should be used with the WebClient. VaultEndpointProvider.getVaultEndpoint() is called on a dedicated Thread to ensure that I/O threads are never blocked.

Parameters:

provider - the VaultEndpoint provider.

Returns:

this WebClientBuilder.

endpointProvider

public WebClientBuilder endpointProvider(ReactiveVaultEndpointProvider provider)

Set the ReactiveVaultEndpointProvider that should be used with the WebClient.

Parameters:

provider - the VaultEndpoint provider.

Returns:

this WebClientBuilder.

httpConnector

public WebClientBuilder httpConnector(ClientHttpConnector httpConnector)

Set the ClientHttpConnector that should be used with the WebClient.

Parameters:

httpConnector - the HTTP connector.

Returns:

this WebClientBuilder.

httpConnectorFactory

public WebClientBuilder httpConnectorFactory(Supplier<ClientHttpConnector> httpConnector)

Set the Supplier of ClientHttpConnector that should be called each time we build() a new WebClient instance.

Parameters:

httpConnector - the supplier for the HTTP connector.

Returns:

this WebClientBuilder.

Since:

2.2.1

requestFactory

@Deprecated
public WebClientBuilder requestFactory(Supplier<ClientHttpConnector> httpConnector)

Deprecated. since 2.2.1 as the name is wrong, use httpConnectorFactory(Supplier)

Set the Supplier of ClientHttpConnector that should be called each time we build() a new WebClient instance.

Parameters:

httpConnector - the supplier for the HTTP connector.

Returns:

this WebClientBuilder.

defaultHeader

public WebClientBuilder defaultHeader(String name,
                                      String value)

Add a default header that will be set if not already present on the outgoing HttpRequest.

Parameters:

name - the name of the header.

value - the header value.

Returns:

this WebClientBuilder.

customizers

public WebClientBuilder customizers(WebClientCustomizer... customizer)

Add the WebClientCustomizers that should be applied to the WebClient. Customizers are applied in the order that they were added.

Parameters:

customizer - the client customizers to add.

Returns:

this WebClientBuilder.

filter

public WebClientBuilder filter(ExchangeFilterFunction... filterFunctions)

Add the ExchangeFilterFunctions that should be applied to the ClientRequest. ExchangeFilterFunctions are applied in the order that they were added.

Parameters:

filterFunctions - the request customizers to add.

Returns:

this WebClientBuilder.

build

public WebClient build()

Build a new WebClient. VaultEndpoint must be set. Applies also ExchangeFilterFunction and WebClientCustomizer if configured.

Returns:

a new WebClient.

createWebClientBuilder

protected WebClient.Builder createWebClientBuilder()

Create the WebClient.Builder to use.

Returns:

the WebClient.Builder to use.