Class VaultTransformContext.VaultTransformRequestBuilder

java.lang.Object

org.springframework.vault.support.VaultTransformContext.VaultTransformRequestBuilder

Enclosing class:

VaultTransformContext

public static class VaultTransformContext.VaultTransformRequestBuilder
extends Object

Builder for VaultTransformContext.

Since:

2.3

Author:

Lauren Voswinkel, Roopesh Chandran

Method Summary

Modifier and Type	Method	Description
VaultTransformContext	build()	Build a new VaultTransformContext instance.
VaultTransformContext.VaultTransformRequestBuilder	reference(String reference)	Set a user-defined reference identifier.
VaultTransformContext.VaultTransformRequestBuilder	transformation(String transformation)	Configure a transformation to be used with the transform operation.
VaultTransformContext.VaultTransformRequestBuilder	tweak(byte[] tweak)	Configure the tweak value for a transform operation.

Methods inherited from class Object

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

Method Details

transformation

public VaultTransformContext.VaultTransformRequestBuilder transformation(String transformation)

Configure a transformation to be used with the transform operation.

Parameters:

transformation - name, provided as a String.

Returns:

this VaultTransformContext.VaultTransformRequestBuilder.

tweak

public VaultTransformContext.VaultTransformRequestBuilder tweak(byte[] tweak)

Configure the tweak value for a transform operation. Must be provided during decoding for all transformations with a tweak_source of "supplied" or "generated". Must be provided during encoding for all transformations with a tweak_source of "supplied".

Parameters:

tweak - value must be exactly 56 bits (7 bytes), value must be supplied during any subsequent decoding after an encoding. Failure to do so will result in a decode that does not return the original value.

Returns:

this VaultTransformContext.VaultTransformRequestBuilder.

reference

public VaultTransformContext.VaultTransformRequestBuilder reference(String reference)

Set a user-defined reference identifier. This reference is placed into each item of a batch request and, if supported by Vault, echoed in the batch results.

Parameters:

reference - the correlation identifier; can be or empty.

Returns:

this builder instance.

Since:

3.2

build

public VaultTransformContext build()

Build a new VaultTransformContext instance.

Returns:

a new VaultTransformContext.