Package org.springframework.vault.core

Class VaultTransformTemplate

java.lang.Object

org.springframework.vault.core.VaultTransformTemplate

All Implemented Interfaces:

VaultTransformOperations

public class VaultTransformTemplate
extends Object
implements VaultTransformOperations

Default implementation of VaultTransformOperations.

Since:

2.3

Author:

Lauren Voswinkel, Mark Paluch

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	decode(String roleName, String ciphertext, VaultTransformContext transformContext)	Decode the provided ciphertext using the named role.
List<VaultTransformDecodeResult>	decode(String roleName, List<TransformCiphertext> batchRequest)	Decode the provided batch of ciphertext using the role given and transformation in each list item.
TransformPlaintext	decode(String roleName, TransformCiphertext ciphertext)	Decode the provided ciphertext using the named role.
String	encode(String roleName, String plaintext)	Encode the provided plaintext using the named role.
List<VaultTransformEncodeResult>	encode(String roleName, List<TransformPlaintext> batchRequest)	Encode the provided batch of plaintext using the role given and transformation in each list item.
TransformCiphertext	encode(String roleName, TransformPlaintext plaintext)	Encode the provided plaintext using the named role.

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

decode, encode

Constructor Details

VaultTransformTemplate

public VaultTransformTemplate(VaultOperations vaultOperations,
 String path)

Create a new VaultTransformTemplate given VaultOperations and the mount path.

Parameters:

vaultOperations - must not be null.

path - must not be empty or null.

Method Details

encode

public String encode(String roleName,
 String plaintext)

Description copied from interface: VaultTransformOperations

Encode the provided plaintext using the named role.

Specified by:

encode in interface VaultTransformOperations

Parameters:

roleName - must not be empty or null.

plaintext - must not be empty or null.

Returns:

cipher text.

encode

public TransformCiphertext encode(String roleName,
 TransformPlaintext plaintext)

Description copied from interface: VaultTransformOperations

Encode the provided plaintext using the named role.

Specified by:

encode in interface VaultTransformOperations

Parameters:

roleName - must not be empty or null.

plaintext - must not be null.

Returns:

cipher text.

encode

public List<VaultTransformEncodeResult> encode(String roleName,
 List<TransformPlaintext> batchRequest)

Description copied from interface: VaultTransformOperations

Encode the provided batch of plaintext using the role given and transformation in each list item. The encryption is done using transformation secret backend's batch operation.

Specified by:

encode in interface VaultTransformOperations

Parameters:

roleName - must not be empty or null.

batchRequest - a list of Plaintext which includes plaintext and an optional context.

Returns:

the encrypted result in the order of batchRequest plaintexts.

decode

public TransformPlaintext decode(String roleName,
 TransformCiphertext ciphertext)

Description copied from interface: VaultTransformOperations

Decode the provided ciphertext using the named role.

Specified by:

decode in interface VaultTransformOperations

Parameters:

roleName - must not be empty or null.

ciphertext - must not be null.

Returns:

plain text.

decode

public String decode(String roleName,
 String ciphertext,
 VaultTransformContext transformContext)

Description copied from interface: VaultTransformOperations

Decode the provided ciphertext using the named role.

Specified by:

decode in interface VaultTransformOperations

Parameters:

roleName - must not be empty or null.

ciphertext - must not be empty or null.

transformContext - must not be null. Use VaultTransformContext.empty() if no request options provided.

Returns:

plain text.

decode

public List<VaultTransformDecodeResult> decode(String roleName,
 List<TransformCiphertext> batchRequest)

Description copied from interface: VaultTransformOperations

Decode the provided batch of ciphertext using the role given and transformation in each list item. The decryption is done using transformation secret backend's batch operation.

Specified by:

decode in interface VaultTransformOperations

Parameters:

roleName - must not be empty or null.

batchRequest - a list of Ciphertext which includes plaintext and an optional context.

Returns:

the decrypted result in the order of batchRequest ciphertexts.