Package org.springframework.vault.client

Interface ReactiveVaultClient

public interface ReactiveVaultClient

Client to perform Vault HTTP requests, exposing a fluent, reactive API over underlying WebClient.

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

ReactiveVaultClient 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()
• exchangeToMono()
• exchangeToFlux()

For examples with a request body see:

• bodyValue(Object)
• body(Publisher,Class)

Since:

4.1

Author:

Mark Paluch

Nested Class Summary

Nested Classes

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

Method Summary

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

Method Details

get

ReactiveVaultClient.RequestHeadersPathSpec<?> get()

Start building an HTTP GET request.

Returns:

a spec for specifying the target path.

post

ReactiveVaultClient.RequestHeadersBodyPathSpec post()

Start building an HTTP POST request.

Returns:

a spec for specifying the target path.

put

ReactiveVaultClient.RequestHeadersBodyPathSpec put()

Start building an HTTP PUT request.

Returns:

a spec for specifying the target path.

delete

ReactiveVaultClient.RequestHeadersPathSpec<?> delete()

Start building an HTTP DELETE request.

Returns:

a spec for specifying the target path.

method

ReactiveVaultClient.RequestHeadersBodyPathSpec method(HttpMethod method)

Start building a request for the given HttpMethod.

Returns:

a spec for specifying the target path.

mutate

ReactiveVaultClient.Builder mutate()

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

create

static ReactiveVaultClient create()

Create a new ReactiveVaultClient.

See Also:

• create(String)
• builder()

create

static ReactiveVaultClient create(String baseUrl)

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

Parameters:

baseUrl - the base URI for all requests.

See Also:

• builder()

create

static ReactiveVaultClient create(VaultEndpoint endpoint)

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

Parameters:

endpoint - the Vault Endpoint for all relative path requests.

See Also:

• builder()

create

static ReactiveVaultClient create(VaultEndpointProvider endpointProvider)

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

Parameters:

endpointProvider - the endpoint provider for all relative path requests.

See Also:

• builder()

create

static ReactiveVaultClient create(ReactiveVaultEndpointProvider endpointProvider)

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

Parameters:

endpointProvider - the endpoint provider for all relative path requests.

See Also:

• builder()

builder

static ReactiveVaultClient.Builder builder()

Obtain a ReactiveVaultClient builder.

builder

static ReactiveVaultClient.Builder builder(WebClient webClient)

Obtain a ReactiveVaultClient builder based on the configuration of the given WebClient.

The WebClient 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 ReactiveVaultClient can be used with relative paths.

Parameters:

webClient - the WebClient to base the returned builder's configuration on.

Returns:

a ReactiveVaultClient builder initialized with webClient's configuration