org.springframework.vault.core

Interface ReactiveVaultOperations

All Known Implementing Classes:

ReactiveVaultTemplate

public interface ReactiveVaultOperations

Interface that specifies a basic set of Vault operations executed on a reactive infrastructure, implemented by ReactiveVaultTemplate. This is the main entry point to interact with Vault in an authenticated and unauthenticated context.

ReactiveVaultOperations allows execution of callback methods. Callbacks can execute requests within a session context and the without a session.

Since:

2.0

Author:

Mark Paluch

See Also:

doWithSession(Function), doWithVault(Function), WebClient, VaultTemplate, VaultTokenOperations, VaultTokenSupplier

Method Summary

Modifier and Type	Method and Description
Mono<Void>	delete(String path) Delete a path.
<V,T extends org.reactivestreams.Publisher<V>> T	doWithSession(Function<WebClient,? extends T> sessionCallback) Executes a Vault RestOperationsCallback.
<V,T extends org.reactivestreams.Publisher<V>> T	doWithVault(Function<WebClient,? extends T> clientCallback) Executes a Vault RestOperationsCallback.
Flux<String>	list(String path) Enumerate keys from a Vault path.
Mono<VaultResponse>	read(String path) Read from a Vault path.
<T> Mono<VaultResponseSupport<T>>	read(String path, Class<T> responseType) Read from a Vault path.
default Mono<VaultResponse>	write(String path) Write to a Vault path.
Mono<VaultResponse>	write(String path, Object body) Write to a Vault path.

Method Detail

read

Mono<VaultResponse> read(String path)

Read from a Vault path. Reading data using this method is suitable for API calls/secret backends that do not require a request body.

Parameters:

path - must not be null.

Returns:

the data. May be empty if the path does not exist.

read

<T> Mono<VaultResponseSupport<T>> read(String path,
                                       Class<T> responseType)

Read from a Vault path. Reading data using this method is suitable for API calls/secret backends that do not require a request body.

Parameters:

path - must not be null.

responseType - must not be null.

Returns:

the data. May be empty if the path does not exist.

list

Flux<String> list(String path)

Enumerate keys from a Vault path.

Parameters:

path - must not be null.

Returns:

the data. May be empty if the path does not exist.

write

default Mono<VaultResponse> write(String path)

Write to a Vault path.

Parameters:

path - must not be null.

Returns:

the response. May be empty if the response has no body.

write

Mono<VaultResponse> write(String path,
                          @Nullable
                          Object body)

Write to a Vault path.

Parameters:

path - must not be null.

body - the body, may be null if absent.

Returns:

the response. May be empty if the response has no body.

delete

Mono<Void> delete(String path)

Delete a path.

Parameters:

path - must not be null.

doWithVault

<V,T extends org.reactivestreams.Publisher<V>> T doWithVault(Function<WebClient,? extends T> clientCallback)
                                                      throws VaultException,
                                                             WebClientException

Executes a Vault RestOperationsCallback. Allows to interact with Vault using RestOperations without requiring a session.

Parameters:

clientCallback - the request.

Returns:

the RestOperationsCallback return value.

Throws:

VaultException - when a HttpStatusCodeException occurs.

WebClientException - exceptions from WebClient.

doWithSession

<V,T extends org.reactivestreams.Publisher<V>> T doWithSession(Function<WebClient,? extends T> sessionCallback)
                                                        throws VaultException,
                                                               WebClientException

Executes a Vault RestOperationsCallback. Allows to interact with Vault in an authenticated session.

Parameters:

sessionCallback - the request.

Returns:

the RestOperationsCallback return value.

Throws:

VaultException - when a HttpStatusCodeException occurs.

WebClientException - exceptions from WebClient.