Package org.springframework.vault.support

Class VaultTransitContext.VaultTransitRequestBuilder

java.lang.Object

org.springframework.vault.support.VaultTransitContext.VaultTransitRequestBuilder

Enclosing class:

VaultTransitContext

public static class VaultTransitContext.VaultTransitRequestBuilder
extends Object

Builder for VaultTransitContext.

Method Summary

Modifier and Type	Method	Description
VaultTransitContext	build()	Build a new VaultTransitContext instance.
VaultTransitContext.VaultTransitRequestBuilder	context(byte[] context)	Configure a key derivation context for the transit operation.
VaultTransitContext.VaultTransitRequestBuilder	keyVersion(int keyVersion)	Configure the key version to use.
VaultTransitContext.VaultTransitRequestBuilder	nonce(byte[] nonce)	Configure the nonce value for a transit operation.

Methods inherited from class java.lang.Object

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

Method Details

context

public VaultTransitContext.VaultTransitRequestBuilder context(byte[] context)

Configure a key derivation context for the transit operation.

Parameters:

context - key derivation context, provided as a binary data. Must be provided if derivation is enabled.

Returns:

this VaultTransitContext.VaultTransitRequestBuilder.

nonce

public VaultTransitContext.VaultTransitRequestBuilder nonce(byte[] nonce)

Configure the nonce value for a transit operation. Must be provided if convergent encryption is enabled for this key and the key was generated with Vault 0.6.1. Not required for keys created in 0.6.2+.

Parameters:

nonce - value must be exactly 96 bits (12 bytes) long and the user must ensure that for any given context (and thus, any given encryption key) this nonce value is never reused

Returns:

this VaultTransitContext.VaultTransitRequestBuilder.

keyVersion

public VaultTransitContext.VaultTransitRequestBuilder keyVersion(int keyVersion)

Configure the key version to use. Must be greater than or equal to the key's min_encryption_version. The key version is not used if not set.

Parameters:

keyVersion - the key version to be used, must be greater than or equal to the key's min_encryption_version

Returns:

this VaultTransitContext.VaultTransitRequestBuilder.

Since:

3.0.3

build

public VaultTransitContext build()

Build a new VaultTransitContext instance.

Returns:

a new VaultTransitContext.