Package org.springframework.vault.client

Class RestClientBuilder

java.lang.Object

org.springframework.vault.client.RestClientBuilder

public class RestClientBuilder
extends Object

Builder that can be used to configure and create a RestClient. Provides convenience methods to configure ClientHttpRequestFactory, error handlers and default headers.

By default, the built RestClient will attempt to use the most suitable ClientHttpRequestFactory using ClientHttpRequestFactoryFactory.create(org.springframework.vault.support.ClientOptions, org.springframework.vault.support.SslConfiguration).

Since:

4.0

Author:

Mark Paluch

See Also:

• ClientHttpRequestFactoryFactory
• RestClientCustomizer

Method Summary

Modifier and Type	Method	Description
RestClient	build()	Build a new RestClient.
static RestClientBuilder	builder()	Create a new RestClientBuilder.
protected RestClient	createClient()	Create the RestClient to use.
RestClientBuilder	customizers(RestClientCustomizer... customizer)	Add the RestClientCustomizers that should be applied to the RestClient.
RestClientBuilder	defaultHeader(String name, String value)	Add a default header that will be set if not already present on the outgoing HttpRequest.
RestClientBuilder	endpoint(VaultEndpoint endpoint)	Set the VaultEndpoint that should be used with the RestClient.
RestClientBuilder	endpointProvider(VaultEndpointProvider provider)	Set the VaultEndpointProvider that should be used with the RestClient.
RestClientBuilder	errorHandler(ResponseErrorHandler errorHandler)	Set the ResponseErrorHandler that should be used with the RestClient.
RestClientBuilder	requestFactory(Supplier<ClientHttpRequestFactory> requestFactory)	Set the Supplier of ClientHttpRequestFactory that should be called each time we build() a new RestClient instance.
RestClientBuilder	requestFactory(ClientHttpRequestFactory requestFactory)	Set the ClientHttpRequestFactory that should be used with the RestClient.
RestClientBuilder	requestInitializers(ClientHttpRequestInitializer... requestInitializer)	Add the ClientHttpRequestInitializers that should be applied to ClientHttpRequest initialization.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static RestClientBuilder builder()

Create a new RestClientBuilder.

Returns:

a new RestClientBuilder.

endpoint

public RestClientBuilder endpoint(VaultEndpoint endpoint)

Set the VaultEndpoint that should be used with the RestClient.

Parameters:

endpoint - the VaultEndpoint provider.

Returns:

this RestClientBuilder.

endpointProvider

public RestClientBuilder endpointProvider(VaultEndpointProvider provider)

Set the VaultEndpointProvider that should be used with the RestClient.

Parameters:

provider - the VaultEndpoint provider.

Returns:

this RestClientBuilder.

requestFactory

public RestClientBuilder requestFactory(ClientHttpRequestFactory requestFactory)

Set the ClientHttpRequestFactory that should be used with the RestClient.

Parameters:

requestFactory - the request factory.

Returns:

this RestClientBuilder.

requestFactory

public RestClientBuilder requestFactory(Supplier<ClientHttpRequestFactory> requestFactory)

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

Parameters:

requestFactory - the supplier for the request factory.

Returns:

this RestClientBuilder.

errorHandler

public RestClientBuilder errorHandler(ResponseErrorHandler errorHandler)

Set the ResponseErrorHandler that should be used with the RestClient.

Parameters:

errorHandler - the error handler to use.

Returns:

this RestClientBuilder.

defaultHeader

public RestClientBuilder 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 RestClientBuilder.

customizers

public RestClientBuilder customizers(RestClientCustomizer... customizer)

Add the RestClientCustomizers that should be applied to the RestClient. Customizers are applied in the order that they were added.

Parameters:

customizer - the template customizers to add.

Returns:

this RestClientBuilder.

requestInitializers

public RestClientBuilder requestInitializers(ClientHttpRequestInitializer... requestInitializer)

Add the ClientHttpRequestInitializers that should be applied to ClientHttpRequest initialization. Customizers are applied in the order that they were added.

Parameters:

requestInitializer - the request initializers to add.

Returns:

this RestClientBuilder.

build

public RestClient build()

Build a new RestClient. VaultEndpoint must be set.

Applies also ResponseErrorHandler and RestTemplateCustomizer if configured.

Returns:

a new RestClient.

createClient

protected RestClient createClient()

Create the RestClient to use.

Returns:

the RestClient to use.