Package org.springframework.vault.client

Class VaultClients

java.lang.Object

org.springframework.vault.client.VaultClients

public class VaultClients
extends Object

Vault Client factory to create RestTemplate / RestClient configured to the needs of accessing Vault.

Author:

Mark Paluch

See Also:

• VaultEndpoint
• RestTemplate

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VaultClients.PrefixAwareUriBuilderFactory
static class	VaultClients.VaultEndpointUriBuilderFactorySupport

Constructor Summary

Constructors

Constructor	Description
VaultClients()

Method Summary

Modifier and Type	Method	Description
static void	configureConverters(Consumer<? super HttpMessageConverter<?>> converterConsumer)	Configure HttpMessageConverters for Vault interaction.
static void	configureConverters(HttpMessageConverters.ClientBuilder clientBuilder)	Configure HttpMessageConverters for Vault interaction.
static ClientHttpRequestInterceptor	createNamespaceInterceptor(String namespace)	Deprecated. since 4.1 in favor of VaultClient.Builder.defaultNamespace(String) and VaultClient.RequestHeadersSpec.namespace(String).
static RestClient	createRestClient(VaultEndpointProvider endpointProvider, ClientHttpRequestFactory requestFactory, Consumer<RestClient.Builder> builderCustomizer)	Create a RestClient configured with VaultEndpointProvider and ClientHttpRequestFactory.
static RestTemplate	createRestTemplate()	Deprecated. since 4.1 in favor of VaultClient.
static RestTemplate	createRestTemplate(VaultEndpointProvider endpointProvider, ClientHttpRequestFactory requestFactory)	Create a RestTemplate configured with VaultEndpointProvider and ClientHttpRequestFactory.
static RestTemplate	createRestTemplate(VaultEndpoint endpoint, ClientHttpRequestFactory requestFactory)	Create a RestTemplate configured with VaultEndpoint and ClientHttpRequestFactory.
static UriBuilderFactory	createUriBuilderFactory(VaultEndpointProvider endpointProvider)

Methods inherited from class java.lang.Object

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

Constructor Details

VaultClients

public VaultClients()

Method Details

createRestTemplate

public static RestTemplate createRestTemplate(VaultEndpoint endpoint,
 ClientHttpRequestFactory requestFactory)

Create a RestTemplate configured with VaultEndpoint and ClientHttpRequestFactory. The template accepts relative URIs without a leading slash that are expanded to use VaultEndpoint. RestTemplate is configured with a ClientHttpRequestInterceptor to enforce serialization to a byte array prior continuing the request. Eager serialization leads to a known request body size that is required to send a HttpHeaders.CONTENT_LENGTH request header. Otherwise, Vault will deny body processing.

Requires Jackson for Object-to-JSON mapping.

Parameters:

endpoint - must not be null.

requestFactory - must not be null.

Returns:

the RestTemplate.

createRestTemplate

public static RestTemplate createRestTemplate(VaultEndpointProvider endpointProvider,
 ClientHttpRequestFactory requestFactory)

Create a RestTemplate configured with VaultEndpointProvider and ClientHttpRequestFactory. The template accepts relative URIs without a leading slash that are expanded to use VaultEndpoint. RestTemplate is configured with a ClientHttpRequestInterceptor to enforce serialization to a byte array prior continuing the request. Eager serialization leads to a known request body size that is required to send a HttpHeaders.CONTENT_LENGTH request header. Otherwise, Vault will deny body processing.

Requires Jackson for Object-to-JSON mapping.

Parameters:

endpointProvider - must not be null.

requestFactory - must not be null.

Returns:

the RestTemplate.

Since:

1.1

createRestClient

public static RestClient createRestClient(VaultEndpointProvider endpointProvider,
 ClientHttpRequestFactory requestFactory,
 Consumer<RestClient.Builder> builderCustomizer)

Create a RestClient configured with VaultEndpointProvider and ClientHttpRequestFactory. The client accepts relative URIs without a leading slash that are expanded to use VaultEndpoint. RestClient is configured to enforce serialization to a byte array prior continuing the request. Eager serialization leads to a known request body size that is required to send a HttpHeaders.CONTENT_LENGTH request header. Otherwise, Vault will deny body processing.

Requires Jackson for Object-to-JSON mapping.

Parameters:

endpointProvider - must not be null.

requestFactory - must not be null.

Returns:

the RestClient.

Since:

4.0

configureConverters

public static void configureConverters(HttpMessageConverters.ClientBuilder clientBuilder)

Configure HttpMessageConverters for Vault interaction. The used converters are:

• ByteArrayHttpMessageConverter
• StringHttpMessageConverter
• If Jackson 3 is on the class path: JacksonJsonHttpMessageConverter
• Alternatively, if Jackson 2 is on the class path: MappingJackson2HttpMessageConverter

Since:

4.1

configureConverters

public static void configureConverters(Consumer<? super HttpMessageConverter<?>> converterConsumer)

Configure HttpMessageConverters for Vault interaction. The used converters are:

• ByteArrayHttpMessageConverter
• StringHttpMessageConverter
• If Jackson 3 is on the class path: JacksonJsonHttpMessageConverter
• Alternatively, if Jackson 2 is on the class path: MappingJackson2HttpMessageConverter

Since:

4.1

createRestTemplate

@Deprecated(since="4.1")
public static RestTemplate createRestTemplate()

Deprecated.

since 4.1 in favor of VaultClient.

Create a RestTemplate for Vault interaction. RestTemplate is configured with a ClientHttpRequestInterceptor to enforce serialization to a byte array prior continuing the request. Eager serialization leads to a known request body size that is required to send a HttpHeaders.CONTENT_LENGTH request header. Otherwise, Vault will deny body processing.

Requires Jackson for Object-to-JSON mapping.

Returns:

the RestTemplate.

createNamespaceInterceptor

@Deprecated(since="4.1")
public static ClientHttpRequestInterceptor createNamespaceInterceptor(String namespace)

Deprecated.

since 4.1 in favor of VaultClient.Builder.defaultNamespace(String) and VaultClient.RequestHeadersSpec.namespace(String).

Create a ClientHttpRequestInterceptor that associates each request with a X-Vault-Namespace header if the header is not present.

Parameters:

namespace - the Vault namespace to use. Must not be null or empty.

Returns:

the ClientHttpRequestInterceptor to register with RestTemplate.

Since:

2.2

See Also:

• VaultHttpHeaders.VAULT_NAMESPACE

createUriBuilderFactory

public static UriBuilderFactory createUriBuilderFactory(VaultEndpointProvider endpointProvider)