Package org.springframework.vault.core

Class ReactiveVaultTemplate

java.lang.Object

org.springframework.vault.core.ReactiveVaultTemplate

All Implemented Interfaces:

ReactiveVaultOperations

public class ReactiveVaultTemplate
extends Object
implements ReactiveVaultOperations

This class encapsulates main Vault interaction. ReactiveVaultTemplate will log into Vault on initialization and use the token throughout the whole lifetime. This is the main entry point to interact with Vault in an authenticated and unauthenticated context.

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

Paths used in this interface (and interfaces accessible from here) are considered relative to the VaultEndpoint. Paths that are fully-qualified URI's can be used to access Vault cluster members in an authenticated context. To prevent unwanted full URI access, make sure to sanitize paths before passing them to this interface.

Since:

2.0

Author:

Mark Paluch, Raoof Mohammed, James Luke, Timothy R. Weiand

See Also:

• SessionManager

Constructor Summary

Constructors

Constructor	Description
ReactiveVaultTemplate(VaultEndpointProvider endpointProvider, ClientHttpConnector connector)	Create a new ReactiveVaultTemplate with a VaultEndpointProvider and ClientHttpConnector.
ReactiveVaultTemplate(VaultEndpointProvider endpointProvider, ClientHttpConnector connector, VaultTokenSupplier vaultTokenSupplier)	Create a new ReactiveVaultTemplate with a VaultEndpointProvider, ClientHttpConnector and VaultTokenSupplier.
ReactiveVaultTemplate(VaultEndpoint vaultEndpoint, ClientHttpConnector connector)	Create a new ReactiveVaultTemplate with a VaultEndpoint, ClientHttpConnector.
ReactiveVaultTemplate(VaultEndpoint vaultEndpoint, ClientHttpConnector connector, VaultTokenSupplier vaultTokenSupplier)	Create a new ReactiveVaultTemplate with a VaultEndpoint, ClientHttpConnector and VaultTokenSupplier.
ReactiveVaultTemplate(WebClientBuilder webClientBuilder)	Create a new ReactiveVaultTemplate through a WebClientBuilder.
ReactiveVaultTemplate(WebClientBuilder webClientBuilder, VaultTokenSupplier vaultTokenSupplier)	Create a new ReactiveVaultTemplate through a WebClientBuilder, and VaultTokenSupplier.

Method Summary

Modifier and Type	Method	Description
Mono<Void>	delete(String path)	Delete a path.
protected WebClient	doCreateSessionWebClient(VaultEndpointProvider endpointProvider, ClientHttpConnector connector)	Create a session-bound WebClient to be used by VaultTemplate for Vault communication given VaultEndpointProvider and ClientHttpConnector for calls that require an authenticated context.
protected WebClient	doCreateWebClient(VaultEndpointProvider endpointProvider, ClientHttpConnector connector)	Create a WebClient to be used by ReactiveVaultTemplate for Vault communication given VaultEndpointProvider and ClientHttpConnector.
<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.
ReactiveVaultKeyValueOperations	opsForKeyValue(String path, VaultKeyValueOperationsSupport.KeyValueBackend apiVersion)
ReactiveVaultSysOperations	opsForSys()
ReactiveVaultTransitOperations	opsForTransit()
ReactiveVaultTransitOperations	opsForTransit(String path)	Return ReactiveVaultTransitOperations if the transit backend is mounted on a different path than transit.
ReactiveVaultVersionedKeyValueOperations	opsForVersionedKeyValue(String path)	Return ReactiveVaultVersionedKeyValueOperations.
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.
Mono<VaultResponse>	write(String path, @Nullable Object body)	Write to a Vault path.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.vault.core.ReactiveVaultOperations

write

Constructor Details

ReactiveVaultTemplate

public ReactiveVaultTemplate(VaultEndpoint vaultEndpoint,
 ClientHttpConnector connector)

Create a new ReactiveVaultTemplate with a VaultEndpoint, ClientHttpConnector. This constructor does not use a VaultTokenSupplier. It is intended for usage with Vault Agent to inherit Vault Agent's authentication without using the authentication token header.

Parameters:

vaultEndpoint - must not be null.

connector - must not be null.

Since:

2.2.1

ReactiveVaultTemplate

public ReactiveVaultTemplate(VaultEndpoint vaultEndpoint,
 ClientHttpConnector connector,
 VaultTokenSupplier vaultTokenSupplier)

Create a new ReactiveVaultTemplate with a VaultEndpoint, ClientHttpConnector and VaultTokenSupplier.

Parameters:

vaultEndpoint - must not be null.

connector - must not be null.

vaultTokenSupplier - must not be null.

ReactiveVaultTemplate

public ReactiveVaultTemplate(VaultEndpointProvider endpointProvider,
 ClientHttpConnector connector)

Create a new ReactiveVaultTemplate with a VaultEndpointProvider and ClientHttpConnector. This constructor does not use a VaultTokenSupplier. It is intended for usage with Vault Agent to inherit Vault Agent's authentication without using the authentication token header.

Parameters:

endpointProvider - must not be null.

connector - must not be null.

Since:

2.2.1

ReactiveVaultTemplate

public ReactiveVaultTemplate(VaultEndpointProvider endpointProvider,
 ClientHttpConnector connector,
 VaultTokenSupplier vaultTokenSupplier)

Create a new ReactiveVaultTemplate with a VaultEndpointProvider, ClientHttpConnector and VaultTokenSupplier.

Parameters:

endpointProvider - must not be null.

connector - must not be null.

vaultTokenSupplier - must not be null.

ReactiveVaultTemplate

public ReactiveVaultTemplate(WebClientBuilder webClientBuilder)

Create a new ReactiveVaultTemplate through a WebClientBuilder. This constructor does not use a VaultTokenSupplier. It is intended for usage with Vault Agent to inherit Vault Agent's authentication without using the authentication token header.

Parameters:

webClientBuilder - must not be null.

Since:

2.2.1

ReactiveVaultTemplate

public ReactiveVaultTemplate(WebClientBuilder webClientBuilder,
 VaultTokenSupplier vaultTokenSupplier)

Create a new ReactiveVaultTemplate through a WebClientBuilder, and VaultTokenSupplier.

Parameters:

webClientBuilder - must not be null.

vaultTokenSupplier - must not be null

Since:

2.2

Method Details

doCreateWebClient

protected WebClient doCreateWebClient(VaultEndpointProvider endpointProvider,
 ClientHttpConnector connector)

Create a WebClient to be used by ReactiveVaultTemplate for Vault communication given VaultEndpointProvider and ClientHttpConnector. VaultEndpointProvider is used to contribute host and port details for relative URLs typically used by the Template API. Subclasses may override this method to customize the WebClient.

Parameters:

endpointProvider - must not be null.

connector - must not be null.

Returns:

the WebClient used for Vault communication.

Since:

2.1

doCreateSessionWebClient

protected WebClient doCreateSessionWebClient(VaultEndpointProvider endpointProvider,
 ClientHttpConnector connector)

Create a session-bound WebClient to be used by VaultTemplate for Vault communication given VaultEndpointProvider and ClientHttpConnector for calls that require an authenticated context. VaultEndpointProvider is used to contribute host and port details for relative URLs typically used by the Template API. Subclasses may override this method to customize the WebClient.

Parameters:

endpointProvider - must not be null.

connector - must not be null.

Returns:

the WebClient used for Vault communication.

Since:

2.1

opsForSys

public ReactiveVaultSysOperations opsForSys()

Specified by:

opsForSys in interface ReactiveVaultOperations

Returns:

the operations interface administrative Vault access.

opsForTransit

public ReactiveVaultTransitOperations opsForTransit()

Specified by:

opsForTransit in interface ReactiveVaultOperations

Returns:

the operations interface to interact with the Vault transit backend.

opsForTransit

public ReactiveVaultTransitOperations opsForTransit(String path)

Description copied from interface: ReactiveVaultOperations

Return ReactiveVaultTransitOperations if the transit backend is mounted on a different path than transit.

Specified by:

opsForTransit in interface ReactiveVaultOperations

Parameters:

path - the mount path

Returns:

the operations interface to interact with the Vault transit backend.

opsForKeyValue

public ReactiveVaultKeyValueOperations opsForKeyValue(String path,
 VaultKeyValueOperationsSupport.KeyValueBackend apiVersion)

Specified by:

opsForKeyValue in interface ReactiveVaultOperations

opsForVersionedKeyValue

public ReactiveVaultVersionedKeyValueOperations opsForVersionedKeyValue(String path)

Description copied from interface: ReactiveVaultOperations

Return ReactiveVaultVersionedKeyValueOperations.

Specified by:

opsForVersionedKeyValue in interface ReactiveVaultOperations

Parameters:

path - the mount path

Returns:

the operations interface to interact with the versioned Vault Key/Value (version 2) backend.

read

public Mono<VaultResponse> read(String path)

Description copied from interface: ReactiveVaultOperations

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

Specified by:

read in interface ReactiveVaultOperations

Parameters:

path - must not be null.

Returns:

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

read

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

Description copied from interface: ReactiveVaultOperations

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

Specified by:

read in interface ReactiveVaultOperations

Parameters:

path - must not be null.

responseType - must not be null.

Returns:

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

list

public Flux<String> list(String path)

Description copied from interface: ReactiveVaultOperations

Enumerate keys from a Vault path.

Specified by:

list in interface ReactiveVaultOperations

Parameters:

path - must not be null.

Returns:

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

write

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

Description copied from interface: ReactiveVaultOperations

Write to a Vault path.

Specified by:

write in interface ReactiveVaultOperations

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

public Mono<Void> delete(String path)

Description copied from interface: ReactiveVaultOperations

Delete a path.

Specified by:

delete in interface ReactiveVaultOperations

Parameters:

path - must not be null.

doWithVault

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

Description copied from interface: ReactiveVaultOperations

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

Specified by:

doWithVault in interface ReactiveVaultOperations

Parameters:

clientCallback - the request.

Returns:

the RestOperationsCallback return value.

Throws:

VaultException - when a HttpStatusCodeException occurs.

WebClientException - exceptions from WebClient.

doWithSession

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

Description copied from interface: ReactiveVaultOperations

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

Specified by:

doWithSession in interface ReactiveVaultOperations

Parameters:

sessionCallback - the request.

Returns:

the RestOperationsCallback return value.

Throws:

VaultException - when a HttpStatusCodeException occurs.

WebClientException - exceptions from WebClient.