Package org.springframework.vault.client

Interface VaultClient

public interface VaultClient

Client to perform Vault HTTP requests, exposing a fluent, synchronous API over underlying RestClient.

Use static factory methods create(), create(String), or builder() to prepare an instance. To use the same configuration as a RestClient, use builder(RestClient) or builder(RestTemplate) respectively.

VaultClient is intended to be used with relative paths requiring a VaultEndpoint to be configured. Without an endpoint, callers must provide the absolute URL for each request.

For examples with a response body see:

• retrieve()

For examples with a request body see:

• body(Object)
• body(Object, ParameterizedTypeReference)

Since:

4.1

Author:

Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	VaultClient.Builder	A mutable builder for creating a VaultClient.
static interface	VaultClient.PathSpec<S extends VaultClient.RequestHeadersSpec<?>>	Contract for specifying the path for a request.
static interface	VaultClient.RequestBodySpec	Contract for specifying request headers and body leading up to the exchange.
static interface	VaultClient.RequestHeadersBodyPathSpec	Contract for specifying request headers, body and path for a request.
static interface	VaultClient.RequestHeadersPathSpec<S extends VaultClient.RequestHeadersSpec<S>>	Contract for specifying request headers and path for a request.
static interface	VaultClient.RequestHeadersSpec<S extends VaultClient.RequestHeadersSpec<S>>	Contract for specifying request headers leading up to the exchange.
static interface	VaultClient.ResponseSpec	Contract for specifying response operations following the exchange.

Method Summary

Modifier and Type	Method	Description
static VaultClient.Builder	builder()	Obtain a VaultClient builder.
static VaultClient.Builder	builder(RestClient restClient)	Obtain a VaultClient builder based on the configuration of the given RestClient.
static VaultClient.Builder	builder(RestTemplate restTemplate)	Obtain a VaultClient builder based on the configuration of the given RestTemplate.
static VaultClient	create()	Create a new VaultClient.
static VaultClient	create(String baseUrl)	Variant of create() that accepts a default base URL.
static VaultClient	create(VaultEndpoint endpoint)	Variant of create() that accepts a default VaultEndpoint.
static VaultClient	create(VaultEndpointProvider endpointProvider)	Variant of create() that accepts a default VaultEndpointProvider.
VaultClient.RequestHeadersPathSpec<?>	delete()	Start building an HTTP DELETE request.
VaultClient.RequestHeadersPathSpec<?>	get()	Start building an HTTP GET request.
VaultClient.RequestHeadersBodyPathSpec	method(HttpMethod method)	Start building a request for the given HttpMethod.
VaultClient.Builder	mutate()	Return a builder to create a new VaultClient whose settings are replicated from this VaultClient.
VaultClient.RequestHeadersBodyPathSpec	post()	Start building an HTTP POST request.
VaultClient.RequestHeadersBodyPathSpec	put()	Start building an HTTP PUT request.

Method Details

get

VaultClient.RequestHeadersPathSpec<?> get()

Start building an HTTP GET request.

Returns:

a spec for specifying the target path.

post

VaultClient.RequestHeadersBodyPathSpec post()

Start building an HTTP POST request.

Returns:

a spec for specifying the target path.

put

VaultClient.RequestHeadersBodyPathSpec put()

Start building an HTTP PUT request.

Returns:

a spec for specifying the target path.

delete

VaultClient.RequestHeadersPathSpec<?> delete()

Start building an HTTP DELETE request.

Returns:

a spec for specifying the target path.

method

VaultClient.RequestHeadersBodyPathSpec method(HttpMethod method)

Start building a request for the given HttpMethod.

Returns:

a spec for specifying the target path.

mutate

VaultClient.Builder mutate()

Return a builder to create a new VaultClient whose settings are replicated from this VaultClient.

create

static VaultClient create()

Create a new VaultClient.

See Also:

• create(String)
• builder()

create

static VaultClient create(String baseUrl)

Variant of create() that accepts a default base URL. For more details see VaultClient.Builder.endpoint(VaultEndpoint).

Parameters:

baseUrl - the base URI for all requests.

See Also:

• builder()

create

static VaultClient create(VaultEndpoint endpoint)

Variant of create() that accepts a default VaultEndpoint. For more details see VaultClient.Builder.endpoint(VaultEndpoint).

Parameters:

endpoint - the Vault Endpoint for all relative path requests.

See Also:

• builder()

create

static VaultClient create(VaultEndpointProvider endpointProvider)

Variant of create() that accepts a default VaultEndpointProvider. For more details see VaultClient.Builder.endpoint(VaultEndpointProvider).

Parameters:

endpointProvider - the endpoint provider for all relative path requests.

See Also:

• builder()

builder

static VaultClient.Builder builder()

Obtain a VaultClient builder.

builder

static VaultClient.Builder builder(RestTemplate restTemplate)

Obtain a VaultClient builder based on the configuration of the given RestTemplate.

The RestTemplate must be configured with appropriate HttpMessageConverters to support String, byte[], and JSON conversion. Additionally, if the template is configured to use a base URL, the built VaultClient can be used with relative paths. The returned builder is configured with the following attributes of the template:

• ClientHttpRequestFactory
• HttpMessageConverters
• ClientHttpRequestInterceptors
• ClientHttpRequestInitializers
• UriBuilderFactory
• error handler

Parameters:

restTemplate - the rest template to base the returned builder's configuration on.

Returns:

a VaultClient builder initialized with restTemplate's configuration.

See Also:

• RestClient.builder(RestTemplate)

builder

static VaultClient.Builder builder(RestClient restClient)

Obtain a VaultClient builder based on the configuration of the given RestClient.

The RestClient must be configured with appropriate HttpMessageConverters to support String, byte[], and JSON conversion. Additionally, if the client is configured to use a base URL, the built VaultClient can be used with relative paths.

Parameters:

restClient - the RestClient to base the returned builder's configuration on.

Returns:

a VaultClient builder initialized with restClient's configuration.