org.springframework.vault.core

Interface VaultOperations

All Known Implementing Classes:

VaultTemplate

public interface VaultOperations

Interface that specifies a basic set of Vault operations, implemented by VaultTemplate. This is the main entry point to interact with Vault in an authenticated and unauthenticated context.

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

Author:

Mark Paluch, Lauren Voswinkel

See Also:

doWithSession(RestOperationsCallback), doWithVault(RestOperationsCallback), RestOperations, VaultTemplate, VaultTokenOperations, SessionManager

Method Summary

Modifier and Type	Method and Description
void	delete(String path) Delete a path.
<T> T	doWithSession(RestOperationsCallback<T> sessionCallback) Executes a Vault RestOperationsCallback.
<T> T	doWithVault(RestOperationsCallback<T> clientCallback) Executes a Vault RestOperationsCallback.
List<String>	list(String path) Enumerate keys from a Vault path.
VaultKeyValueOperations	opsForKeyValue(String path, VaultKeyValueOperationsSupport.KeyValueBackend apiVersion) Return VaultKeyValueOperations.
VaultPkiOperations	opsForPki()
VaultPkiOperations	opsForPki(String path) Return VaultPkiOperations if the PKI backend is mounted on a different path than pki.
VaultSysOperations	opsForSys()
VaultTokenOperations	opsForToken()
VaultTransformOperations	opsForTransform()
VaultTransformOperations	opsForTransform(String path) Return VaultTransformOperations if the transit backend is mounted on a different path than transform.
VaultTransitOperations	opsForTransit()
VaultTransitOperations	opsForTransit(String path) Return VaultTransitOperations if the transit backend is mounted on a different path than transit.
VaultVersionedKeyValueOperations	opsForVersionedKeyValue(String path) Return VaultVersionedKeyValueOperations.
VaultWrappingOperations	opsForWrapping()
VaultResponse	read(String path) Read from a Vault path.
<T> VaultResponseSupport<T>	read(String path, Class<T> responseType) Read from a secret backend.
default VaultResponse	write(String path) Write to a Vault path.
VaultResponse	write(String path, Object body) Write to a Vault path.

Method Detail

opsForKeyValue

VaultKeyValueOperations opsForKeyValue(String path,
                                       VaultKeyValueOperationsSupport.KeyValueBackend apiVersion)

Return VaultKeyValueOperations.

Parameters:

path - the mount path, must not be empty or null.

apiVersion - API version to use, must not be null.

Returns:

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

Since:

2.1

opsForVersionedKeyValue

VaultVersionedKeyValueOperations opsForVersionedKeyValue(String path)

Return VaultVersionedKeyValueOperations.

Parameters:

path - the mount path

Returns:

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

Since:

2.1

opsForPki

VaultPkiOperations opsForPki()

Returns:

the operations interface to interact with the Vault PKI backend.

opsForPki

VaultPkiOperations opsForPki(String path)

Return VaultPkiOperations if the PKI backend is mounted on a different path than pki.

Parameters:

path - the mount path

Returns:

the operations interface to interact with the Vault PKI backend.

opsForSys

VaultSysOperations opsForSys()

Returns:

the operations interface administrative Vault access.

opsForToken

VaultTokenOperations opsForToken()

Returns:

the operations interface to interact with Vault token.

opsForTransform

VaultTransformOperations opsForTransform()

Returns:

the operations interface to interact with the Vault transform backend.

Since:

2.3

opsForTransform

VaultTransformOperations opsForTransform(String path)

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

Parameters:

path - the mount path

Returns:

the operations interface to interact with the Vault transform backend.

Since:

2.3

opsForTransit

VaultTransitOperations opsForTransit()

Returns:

the operations interface to interact with the Vault transit backend.

opsForTransit

VaultTransitOperations opsForTransit(String path)

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

Parameters:

path - the mount path

Returns:

the operations interface to interact with the Vault transit backend.

opsForWrapping

VaultWrappingOperations opsForWrapping()

Returns:

the operations interface to interact with the Vault system/wrapping endpoints.

Since:

2.1

read

@Nullable
VaultResponse read(String path)

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

Parameters:

path - must not be null.

Returns:

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

read

@Nullable
<T> VaultResponseSupport<T> read(String path,
                                           Class<T> responseType)

Read from a secret backend. Reading data using this method is suitable for secret backends that do not require a request body.

Parameters:

path - must not be null.

responseType - must not be null.

Returns:

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

list

@Nullable
List<String> list(String path)

Enumerate keys from a Vault path.

Parameters:

path - must not be null.

Returns:

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

write

@Nullable
default VaultResponse write(String path)

Write to a Vault path.

Parameters:

path - must not be null.

Returns:

the response, may be null.

Since:

2.0

write

@Nullable
VaultResponse write(String path,
                              @Nullable
                              Object body)

Write to a Vault path.

Parameters:

path - must not be null.

body - the body, may be null if absent.

Returns:

the response, may be null.

delete

void delete(String path)

Delete a path.

Parameters:

path - must not be null.

doWithVault

@Nullable
<T> T doWithVault(RestOperationsCallback<T> clientCallback)
                     throws VaultException,
                            org.springframework.web.client.RestClientException

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

Parameters:

clientCallback - the request.

Returns:

the RestOperationsCallback return value.

Throws:

VaultException - when a HttpStatusCodeException occurs.

org.springframework.web.client.RestClientException - exceptions from RestOperations.

doWithSession

@Nullable
<T> T doWithSession(RestOperationsCallback<T> sessionCallback)
                       throws VaultException,
                              org.springframework.web.client.RestClientException

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

Parameters:

sessionCallback - the request.

Returns:

the RestOperationsCallback return value.

Throws:

VaultException - when a HttpStatusCodeException occurs.

org.springframework.web.client.RestClientException - exceptions from RestOperations.