Package org.springframework.vault.client

Class RestTemplateBuilder

java.lang.Object

org.springframework.vault.client.RestTemplateBuilder

public class RestTemplateBuilder
extends Object

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

Since:

2.2

Author:

Mark Paluch

See Also:

• ClientHttpRequestFactoryFactory
• RestTemplateCustomizer

Method Summary

Modifier and Type	Method	Description
RestTemplate	build()	Build a new RestTemplate.
static RestTemplateBuilder	builder()	Create a new RestTemplateBuilder.
protected RestTemplate	createTemplate()	Create the RestTemplate to use.
RestTemplateBuilder	customizers(RestTemplateCustomizer... customizer)	Add the RestTemplateCustomizers that should be applied to the RestTemplate.
RestTemplateBuilder	defaultHeader(String name, String value)	Add a default header that will be set if not already present on the outgoing HttpRequest.
RestTemplateBuilder	endpoint(VaultEndpoint endpoint)	Set the VaultEndpoint that should be used with the RestTemplate.
RestTemplateBuilder	endpointProvider(VaultEndpointProvider provider)	Set the VaultEndpointProvider that should be used with the RestTemplate.
RestTemplateBuilder	errorHandler(ResponseErrorHandler errorHandler)	Set the ResponseErrorHandler that should be used with the RestTemplate.
RestTemplateBuilder	requestCustomizers(RestTemplateRequestCustomizer<?>... requestCustomizers)	Add the RestTemplateRequestCustomizers that should be applied to the ClientHttpRequest.
RestTemplateBuilder	requestFactory(Supplier<ClientHttpRequestFactory> requestFactory)	Set the Supplier of ClientHttpRequestFactory that should be called each time we build() a new RestTemplate instance.
RestTemplateBuilder	requestFactory(ClientHttpRequestFactory requestFactory)	Set the ClientHttpRequestFactory that should be used with the RestTemplate.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static RestTemplateBuilder builder()

Create a new RestTemplateBuilder.

Returns:

a new RestTemplateBuilder.

endpoint

public RestTemplateBuilder endpoint(VaultEndpoint endpoint)

Set the VaultEndpoint that should be used with the RestTemplate.

Parameters:

endpoint - the VaultEndpoint provider.

Returns:

this RestTemplateBuilder.

endpointProvider

public RestTemplateBuilder endpointProvider(VaultEndpointProvider provider)

Set the VaultEndpointProvider that should be used with the RestTemplate.

Parameters:

provider - the VaultEndpoint provider.

Returns:

this RestTemplateBuilder.

requestFactory

public RestTemplateBuilder requestFactory(ClientHttpRequestFactory requestFactory)

Set the ClientHttpRequestFactory that should be used with the RestTemplate.

Parameters:

requestFactory - the request factory.

Returns:

this RestTemplateBuilder.

requestFactory

public RestTemplateBuilder requestFactory(Supplier<ClientHttpRequestFactory> requestFactory)

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

Parameters:

requestFactory - the supplier for the request factory.

Returns:

this RestTemplateBuilder.

errorHandler

public RestTemplateBuilder errorHandler(ResponseErrorHandler errorHandler)

Set the ResponseErrorHandler that should be used with the RestTemplate.

Parameters:

errorHandler - the error handler to use.

Returns:

this RestTemplateBuilder.

defaultHeader

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

customizers

public RestTemplateBuilder customizers(RestTemplateCustomizer... customizer)

Add the RestTemplateCustomizers that should be applied to the RestTemplate. Customizers are applied in the order that they were added.

Parameters:

customizer - the template customizers to add.

Returns:

this RestTemplateBuilder.

requestCustomizers

public RestTemplateBuilder requestCustomizers(RestTemplateRequestCustomizer<?>... requestCustomizers)

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

Parameters:

requestCustomizers - the request customizers to add.

Returns:

this RestTemplateBuilder.

build

public RestTemplate build()

Build a new RestTemplate. VaultEndpoint must be set. Applies also ResponseErrorHandler and RestTemplateCustomizer if configured.

Returns:

a new RestTemplate.

createTemplate

protected RestTemplate createTemplate()

Create the RestTemplate to use.

Returns:

the RestTemplate to use.