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.

Author:

Mark Paluch

See Also:

SessionManager

Constructor Summary

Constructors

Constructor and Description
ReactiveVaultTemplate(VaultEndpoint vaultEndpoint, org.springframework.http.client.reactive.ClientHttpConnector connector, VaultTokenSupplier vaultTokenSupplier) Create a new ReactiveVaultTemplate with a VaultEndpoint, ClientHttpConnector and VaultTokenSupplier.
ReactiveVaultTemplate(VaultEndpointProvider endpointProvider, org.springframework.http.client.reactive.ClientHttpConnector connector, VaultTokenSupplier vaultTokenSupplier) Create a new ReactiveVaultTemplate with a VaultEndpointProvider, ClientHttpConnector and VaultTokenSupplier.

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<Void>	delete(String path) Delete a path.
<V,T extends org.reactivestreams.Publisher<V>> T	doWithSession(Function<org.springframework.web.reactive.function.client.WebClient,? extends T> sessionCallback) Executes a Vault RestOperationsCallback.
<V,T extends org.reactivestreams.Publisher<V>> T	doWithVault(Function<org.springframework.web.reactive.function.client.WebClient,? extends T> clientCallback) Executes a Vault RestOperationsCallback.
reactor.core.publisher.Flux<String>	list(String path) Enumerate keys from a Vault path.
reactor.core.publisher.Mono<VaultResponse>	read(String path) Read from a Vault path.
<T> reactor.core.publisher.Mono<VaultResponseSupport<T>>	read(String path, Class<T> responseType) Read from a Vault path.
reactor.core.publisher.Mono<VaultResponse>	write(String path, 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 Detail

ReactiveVaultTemplate

public ReactiveVaultTemplate(VaultEndpoint vaultEndpoint,
                             org.springframework.http.client.reactive.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,
                             org.springframework.http.client.reactive.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.

Method Detail

read

public reactor.core.publisher.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> reactor.core.publisher.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 reactor.core.publisher.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 reactor.core.publisher.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 reactor.core.publisher.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<org.springframework.web.reactive.function.client.WebClient,? extends T> clientCallback)
                                                             throws VaultException,
                                                                    org.springframework.web.reactive.function.client.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.

org.springframework.web.reactive.function.client.WebClientException - exceptions from WebClient.

doWithSession

public <V,T extends org.reactivestreams.Publisher<V>> T doWithSession(Function<org.springframework.web.reactive.function.client.WebClient,? extends T> sessionCallback)
                                                               throws VaultException,
                                                                      org.springframework.web.reactive.function.client.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.

org.springframework.web.reactive.function.client.WebClientException - exceptions from WebClient.