Package org.springframework.vault.support

Class VaultHmacRequest.VaultHmacRequestBuilder

java.lang.Object

org.springframework.vault.support.VaultHmacRequest.VaultHmacRequestBuilder

Enclosing class:

VaultHmacRequest

public static class VaultHmacRequest.VaultHmacRequestBuilder
extends Object

Builder to build a VaultHmacRequest.

Constructor Summary

Constructors

Constructor	Description
VaultHmacRequestBuilder()

Method Summary

Modifier and Type	Method	Description
VaultHmacRequest.VaultHmacRequestBuilder	algorithm(String algorithm)	Configure the algorithm to be used for the operation.
VaultHmacRequest	build()	Build a new VaultHmacRequest instance.
VaultHmacRequest.VaultHmacRequestBuilder	keyVersion(int version)	Configure the key version to be used for the operation.
VaultHmacRequest.VaultHmacRequestBuilder	plaintext(Plaintext input)	Configure the input to be used to create the digest.

Methods inherited from class java.lang.Object

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

Constructor Details

VaultHmacRequestBuilder

public VaultHmacRequestBuilder()

Method Details

plaintext

public VaultHmacRequest.VaultHmacRequestBuilder plaintext(Plaintext input)

Configure the input to be used to create the digest.

Parameters:

input - base input to create the digest, must not be null.

Returns:

this VaultHmacRequest.VaultHmacRequestBuilder.

algorithm

public VaultHmacRequest.VaultHmacRequestBuilder algorithm(String algorithm)

Configure the algorithm to be used for the operation.

Parameters:

algorithm - Specify the algorithm to be used for the operation. Supported algorithms are: sha2-224, sha2-256, sha2-384, sha2-512. Defaults to sha2-256 if not set.

Returns:

this VaultHmacRequest.VaultHmacRequestBuilder.

keyVersion

public VaultHmacRequest.VaultHmacRequestBuilder keyVersion(int version)

Configure the key version to be used for the operation.

Parameters:

version - key version to be used. If not set, uses the latest version.

Returns:

this VaultHmacRequest.VaultHmacRequestBuilder.

build

public VaultHmacRequest build()

Build a new VaultHmacRequest instance. Requires plaintext(Plaintext) to be configured.

Returns:

a new VaultHmacRequest.