Package org.springframework.vault.core
Interface VaultTransformOperations
- All Known Implementing Classes:
VaultTransformTemplate
public interface VaultTransformOperations
Interface that specifies operations using the
transform
backend.- Since:
- 2.3
- Author:
- Lauren Voswinkel, Mark Paluch
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptiondefault String
Decode the provided ciphertext using the named role.decode
(String roleName, String ciphertext, VaultTransformContext transformContext) Decode the provided ciphertext using the named role.decode
(String roleName, List<TransformCiphertext> batchRequest) Decode the provided batch of ciphertext using the role given and transformation in each list item.decode
(String roleName, TransformCiphertext ciphertext) Decode the provided ciphertext using the named role.default TransformCiphertext
encode
(String roleName, byte[] plaintext, VaultTransformContext transformRequest) Encode the provided plaintext using the named role.Encode the provided plaintext using the named role.encode
(String roleName, List<TransformPlaintext> batchRequest) Encode the provided batch of plaintext using the role given and transformation in each list item.encode
(String roleName, TransformPlaintext plaintext) Encode the provided plaintext using the named role.
-
Method Details
-
encode
Encode the provided plaintext using the named role.- Parameters:
roleName
- must not be empty or null.plaintext
- must not be empty or null.- Returns:
- cipher text.
-
encode
Encode the provided plaintext using the named role.- Parameters:
roleName
- must not be empty or null.plaintext
- must not be null.- Returns:
- cipher text.
-
encode
default TransformCiphertext encode(String roleName, byte[] plaintext, VaultTransformContext transformRequest) Encode the provided plaintext using the named role.- Parameters:
roleName
- must not be empty or null.plaintext
- must not be empty or null.transformRequest
- must not be null. UseVaultTransformContext.empty()
if no request options provided.- Returns:
- cipher text.
-
encode
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.- Parameters:
roleName
- must not be empty or null.batchRequest
- a list ofPlaintext
which includes plaintext and an optional context.- Returns:
- the encrypted result in the order of
batchRequest
plaintexts.
-
decode
Decode the provided ciphertext using the named role.- Parameters:
roleName
- must not be empty or null.ciphertext
- must not be empty or null.- Returns:
- plain text.
-
decode
Decode the provided ciphertext using the named role.- Parameters:
roleName
- must not be empty or null.ciphertext
- must not be null.- Returns:
- plain text.
-
decode
Decode the provided ciphertext using the named role.- Parameters:
roleName
- must not be empty or null.ciphertext
- must not be empty or null.transformContext
- must not be null. UseVaultTransformContext.empty()
if no request options provided.- Returns:
- plain text.
-
decode
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.- Parameters:
roleName
- must not be empty or null.batchRequest
- a list ofCiphertext
which includes plaintext and an optional context.- Returns:
- the decrypted result in the order of
batchRequest
ciphertexts.
-