Package org.springframework.vault.core

Class ReactiveVaultVersionedKeyValueTemplate

java.lang.Object

org.springframework.vault.core.ReactiveVaultVersionedKeyValueTemplate

All Implemented Interfaces:

ReactiveVaultKeyValueOperationsSupport, ReactiveVaultVersionedKeyValueOperations

public class ReactiveVaultVersionedKeyValueTemplate
extends Object
implements ReactiveVaultVersionedKeyValueOperations

Default implementation of ReactiveVaultVersionedKeyValueOperations.

Since:

3.1

Author:

Timothy R. Weiand

Field Summary

Fields

Modifier and Type	Field	Description
protected final ReactiveVaultOperations	reactiveVaultOperations

Constructor Summary

Constructors

Constructor	Description
ReactiveVaultVersionedKeyValueTemplate(ReactiveVaultOperations reactiveVaultOperations, String path)	Create a new ReactiveVaultVersionedKeyValueTemplate given ReactiveVaultOperations and the mount path.

Method Summary

Modifier and Type	Method	Description
Mono<Void>	delete(String path)	Delete the secret at path.
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.
Mono<Versioned<Map<String,Object>>>	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.
VaultKeyValueOperationsSupport.KeyValueBackend	getApiVersion()
Flux<String>	list(String path)	Enumerate keys from a Vault path.
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 class java.lang.Object

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

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

delete, getApiVersion, list

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

get, get

Field Details

reactiveVaultOperations

protected final ReactiveVaultOperations reactiveVaultOperations

Constructor Details

ReactiveVaultVersionedKeyValueTemplate

public ReactiveVaultVersionedKeyValueTemplate(ReactiveVaultOperations reactiveVaultOperations,
 String path)

Create a new ReactiveVaultVersionedKeyValueTemplate given ReactiveVaultOperations and the mount path.

Parameters:

reactiveVaultOperations - must not be null.

path - must not be empty or null.

Method Details

get

public Mono<Versioned<Map<String,Object>>> get(String path,
 Versioned.Version version)

Description copied from interface: ReactiveVaultVersionedKeyValueOperations

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

Specified by:

get in interface ReactiveVaultVersionedKeyValueOperations

Parameters:

path - must not be null.

version - must not be null.

Returns:

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

get

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

Description copied from interface: ReactiveVaultVersionedKeyValueOperations

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

Specified by:

get in interface ReactiveVaultVersionedKeyValueOperations

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

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

Description copied from interface: ReactiveVaultVersionedKeyValueOperations

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).

Specified by:

put in interface ReactiveVaultVersionedKeyValueOperations

Parameters:

path - must not be null.

body - must not be null.

Returns:

the resulting Versioned.Metadata.

delete

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

Description copied from interface: ReactiveVaultVersionedKeyValueOperations

Delete one or more versions of the secret at path.

Specified by:

delete in interface ReactiveVaultVersionedKeyValueOperations

Parameters:

path - must not be null.

versionsToDelete - must not be null or empty.

undelete

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

Description copied from interface: ReactiveVaultVersionedKeyValueOperations

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

Specified by:

undelete in interface ReactiveVaultVersionedKeyValueOperations

Parameters:

path - must not be null.

versionsToDelete - must not be null or empty.

destroy

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

Description copied from interface: ReactiveVaultVersionedKeyValueOperations

Permanently remove the specified versions of the secret at path.

Specified by:

destroy in interface ReactiveVaultVersionedKeyValueOperations

Parameters:

path - must not be null.

versionsToDelete - must not be null or empty.

opsForKeyValueMetadata

public ReactiveVaultKeyValueMetadataOperations opsForKeyValueMetadata()

Description copied from interface: ReactiveVaultVersionedKeyValueOperations

Return ReactiveVaultKeyValueMetadataOperations

Specified by:

opsForKeyValueMetadata in interface ReactiveVaultVersionedKeyValueOperations

Returns:

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

list

public Flux<String> list(String path)

Description copied from interface: ReactiveVaultKeyValueOperationsSupport

Enumerate keys from a Vault path.

Parameters:

path - must not be null.

Returns:

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

getApiVersion

public VaultKeyValueOperationsSupport.KeyValueBackend getApiVersion()

Returns:

the used API version.

delete

public Mono<Void> delete(String path)

Description copied from interface: ReactiveVaultKeyValueOperationsSupport

Delete the secret at path.

Specified by:

delete in interface ReactiveVaultKeyValueOperationsSupport

Parameters:

path - must not be null.