org.springframework.vault.core

Class VaultVersionedKeyValueTemplate

java.lang.Object

org.springframework.vault.core.VaultVersionedKeyValueTemplate

All Implemented Interfaces:

VaultKeyValueOperationsSupport, VaultVersionedKeyValueOperations

public class VaultVersionedKeyValueTemplate
extends Object
implements VaultVersionedKeyValueOperations

Default implementation of VaultVersionedKeyValueOperations.

Since:

2.1

Author:

Mark Paluch, Maciej Drozdzowski

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.vault.core.VaultKeyValueOperationsSupport

VaultKeyValueOperationsSupport.KeyValueBackend

Constructor Summary

Constructors

Constructor and Description
VaultVersionedKeyValueTemplate(VaultOperations vaultOperations, String path) Create a new VaultVersionedKeyValueTemplate given VaultOperations and the mount path.

Method Summary

Modifier and Type	Method and Description
void	delete(String path) Delete the secret at path.
void	delete(String path, Versioned.Version... versionsToDelete) Delete one or more versions of the secret at path.
void	destroy(String path, Versioned.Version... versionsToDelete) Permanently remove the specified versions of the secret at path.
Versioned<Map<String,Object>>	get(String path, Versioned.Version version) Read the requested Versioned.Version of the secret at path.
<T> 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()
List<String>	list(String path) Enumerate keys from a Vault path.
VaultKeyValueMetadataOperations	opsForKeyValueMetadata() Return VaultKeyValueMetadataOperations
Versioned.Metadata	put(String path, Object body) Write the versioned secret at path.
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.VaultVersionedKeyValueOperations

get, get

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

delete, getApiVersion, list

Constructor Detail

VaultVersionedKeyValueTemplate

public VaultVersionedKeyValueTemplate(VaultOperations vaultOperations,
                                      String path)

Create a new VaultVersionedKeyValueTemplate given VaultOperations and the mount path.

Parameters:

vaultOperations - must not be null.

path - must not be empty or null.

Method Detail

get

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

Description copied from interface: VaultVersionedKeyValueOperations

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

Specified by:

get in interface VaultVersionedKeyValueOperations

Parameters:

path - must not be null.

version - must not be null.

Returns:

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

get

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

Description copied from interface: VaultVersionedKeyValueOperations

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

Specified by:

get in interface VaultVersionedKeyValueOperations

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 Versioned.Metadata put(String path,
                              Object body)

Description copied from interface: VaultVersionedKeyValueOperations

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 VaultVersionedKeyValueOperations

Parameters:

path - must not be null.

body - must not be null.

Returns:

the resulting Versioned.Metadata.

delete

public void delete(String path,
                   Versioned.Version... versionsToDelete)

Description copied from interface: VaultVersionedKeyValueOperations

Delete one or more versions of the secret at path.

Specified by:

delete in interface VaultVersionedKeyValueOperations

Parameters:

path - must not be null.

versionsToDelete - must not be null or empty.

undelete

public void undelete(String path,
                     Versioned.Version... versionsToDelete)

Description copied from interface: VaultVersionedKeyValueOperations

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

Specified by:

undelete in interface VaultVersionedKeyValueOperations

Parameters:

path - must not be null.

versionsToDelete - must not be null or empty.

destroy

public void destroy(String path,
                    Versioned.Version... versionsToDelete)

Description copied from interface: VaultVersionedKeyValueOperations

Permanently remove the specified versions of the secret at path.

Specified by:

destroy in interface VaultVersionedKeyValueOperations

Parameters:

path - must not be null.

versionsToDelete - must not be null or empty.

opsForKeyValueMetadata

public VaultKeyValueMetadataOperations opsForKeyValueMetadata()

Description copied from interface: VaultVersionedKeyValueOperations

Return VaultKeyValueMetadataOperations

Specified by:

opsForKeyValueMetadata in interface VaultVersionedKeyValueOperations

Returns:

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

list

@Nullable
public List<String> list(String path)

Description copied from interface: VaultKeyValueOperationsSupport

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 void delete(String path)

Description copied from interface: VaultKeyValueOperationsSupport

Delete the secret at path.

Specified by:

delete in interface VaultKeyValueOperationsSupport

Parameters:

path - must not be null.