Package org.springframework.vault.core

Class VaultWrappingTemplate

java.lang.Object

org.springframework.vault.core.VaultWrappingTemplate

All Implemented Interfaces:

VaultWrappingOperations

public class VaultWrappingTemplate
extends Object
implements VaultWrappingOperations

Default implementation of VaultWrappingOperations.

Author:

Mark Paluch

Constructor Summary

Constructors

Constructor	Description
VaultWrappingTemplate(VaultOperations vaultOperations)	Create a new VaultWrappingTemplate given VaultOperations.

Method Summary

Modifier and Type	Method	Description
@Nullable WrappedMetadata	lookup(VaultToken token)	Looks up metadata for the given token containing a wrapped response.
@Nullable VaultResponse	read(VaultToken token)	Read a wrapped secret.
<T> @Nullable VaultResponseSupport<T>	read(VaultToken token, Class<T> responseType)	Read a wrapped secret of type responseType.
WrappedMetadata	rewrap(VaultToken token)	Rewraps a response-wrapped token.
WrappedMetadata	wrap(Object body, Duration duration)	Wraps the given user-supplied data inside a response-wrapped token.

Methods inherited from class java.lang.Object

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

Constructor Details

VaultWrappingTemplate

public VaultWrappingTemplate(VaultOperations vaultOperations)

Create a new VaultWrappingTemplate given VaultOperations.

Parameters:

vaultOperations - must not be null.

Method Details

lookup

public @Nullable WrappedMetadata lookup(VaultToken token)

Description copied from interface: VaultWrappingOperations

Looks up metadata for the given token containing a wrapped response.

Specified by:

lookup in interface VaultWrappingOperations

Parameters:

token - must not be null.

Returns:

the WrappedMetadata the token or null if the token was invalid or expired.

read

public @Nullable VaultResponse read(VaultToken token)

Description copied from interface: VaultWrappingOperations

Read a wrapped secret.

Specified by:

read in interface VaultWrappingOperations

Parameters:

token - must not be null.

Returns:

the data or null if the token was invalid or expired.

read

public <T> @Nullable VaultResponseSupport<T> read(VaultToken token,
 Class<T> responseType)

Description copied from interface: VaultWrappingOperations

Read a wrapped secret of type responseType.

Specified by:

read in interface VaultWrappingOperations

Parameters:

token - must not be null.

responseType - must not be null.

Returns:

the data or null if the token was invalid or expired.

rewrap

public WrappedMetadata rewrap(VaultToken token)

Description copied from interface: VaultWrappingOperations

Rewraps a response-wrapped token. The new token will use the same creation TTL as the original token and contain the same response. The old token will be invalidated. This can be used for long-term storage of a secret in a response-wrapped token when rotation is a requirement. Rewrapping with an invalid token throws VaultException.

Specified by:

rewrap in interface VaultWrappingOperations

Parameters:

token - must not be null.

Returns:

the WrappedMetadata for this wrapping operation.

wrap

public WrappedMetadata wrap(Object body,
 Duration duration)

Description copied from interface: VaultWrappingOperations

Wraps the given user-supplied data inside a response-wrapped token.

Specified by:

wrap in interface VaultWrappingOperations

Parameters:

body - must not be null.

duration - must not be null.

Returns:

the WrappedMetadata for this wrapping operation.