Package org.springframework.vault.core

Interface ReactiveVaultVersionedKeyValueOperations

All Superinterfaces:

ReactiveVaultKeyValueOperationsSupport

All Known Implementing Classes:

ReactiveVaultVersionedKeyValueTemplate

public interface ReactiveVaultVersionedKeyValueOperations
extends ReactiveVaultKeyValueOperationsSupport

Interface that specifies a basic set of Vault operations using Vault's versioned Key/Value (kv version 2) secret backend. Paths used in this operations interface are relative and outgoing requests prepend paths with the according operation-specific prefix.

Clients using versioned Key/Value must be aware they are reading from a versioned backend as the versioned Key/Value API (kv version 2) is different from the unversioned Key/Value API (kv version 1). TODO: Update JavaDocs

Since:

3.1

Author:

Timothy R. Weiand

See Also:

• ReactiveVaultKeyValueOperations

Method Summary

Modifier and Type	Method	Description
Mono<Void>	delete(String path, Versioned.Version... versionsToDelete)	Delete one or more versions of the secret at path.
Mono<Void>	destroy(String path, Versioned.Version... versionsToDelete)	Permanently remove the specified versions of the secret at path.
default Mono<Versioned<Map<String,Object>>>	get(String path)	Read the most recent secret at path.
default <T> Mono<Versioned<T>>	get(String path, Class<T> responseType)	Read the most recent secret at path and deserialize the secret to the given responseType.
<T> Mono<Versioned<T>>	get(String path, Versioned.Version version)	Read the requested Versioned.Version of the secret at path.
<T> Mono<Versioned<T>>	get(String path, Versioned.Version version, Class<T> responseType)	Read the requested Versioned.Version of the secret at path and deserialize the secret to the given responseType.
ReactiveVaultKeyValueMetadataOperations	opsForKeyValueMetadata()	Return ReactiveVaultKeyValueMetadataOperations
Mono<Versioned.Metadata>	put(String path, Object body)	Write the versioned secret at path.
Mono<Void>	undelete(String path, Versioned.Version... versionsToDelete)	Undelete (restore) one or more versions of the secret at path.

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

delete, getApiVersion, list

Method Details

get

default Mono<Versioned<Map<String,Object>>> get(String path)

Read the most recent secret at path.

Specified by:

get in interface ReactiveVaultKeyValueOperationsSupport

Parameters:

path - must not be null.

Returns:

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

get

<T> Mono<Versioned<T>> get(String path,
 Versioned.Version version)

Read the requested Versioned.Version of the secret at path.

Parameters:

path - must not be null.

version - must not be null.

Returns:

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

get

default <T> Mono<Versioned<T>> get(String path,
 Class<T> responseType)

Read the most recent secret at path and deserialize the secret to the given responseType.

Parameters:

path - must not be null.

responseType - must not be null.

Returns:

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

get

<T> Mono<Versioned<T>> get(String path,
 Versioned.Version version,
 Class<T> responseType)

Read the requested Versioned.Version of the secret at path and deserialize the secret to the given responseType.

Parameters:

path - must not be null.

version - must not be null.

responseType - must not be null.

Returns:

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

put

Mono<Versioned.Metadata> put(String path,
 Object body)

Write the versioned secret at path. body may be either plain secrets (e.g. map) or Versioned objects. Using Versioned will apply versioning for Compare-and-Set (CAS).

Parameters:

path - must not be null.

body - must not be null.

Returns:

the resulting Versioned.Metadata.

delete

Mono<Void> delete(String path,
 Versioned.Version... versionsToDelete)

Delete one or more versions of the secret at path.

Parameters:

path - must not be null.

versionsToDelete - must not be null or empty.

undelete

Mono<Void> undelete(String path,
 Versioned.Version... versionsToDelete)

Undelete (restore) one or more versions of the secret at path.

Parameters:

path - must not be null.

versionsToDelete - must not be null or empty.

destroy

Mono<Void> destroy(String path,
 Versioned.Version... versionsToDelete)

Permanently remove the specified versions of the secret at path.

Parameters:

path - must not be null.

versionsToDelete - must not be null or empty.

opsForKeyValueMetadata

ReactiveVaultKeyValueMetadataOperations opsForKeyValueMetadata()

Return ReactiveVaultKeyValueMetadataOperations

Returns:

the operations interface to interact with the Vault Key/Value metadata backend