Package org.springframework.vault.support

Class VaultHmacRequest

java.lang.Object

org.springframework.vault.support.VaultHmacRequest

public class VaultHmacRequest
extends Object

Request for a HMAC Digest.

Since:

2.0

Author:

Luander Ribeiro, Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VaultHmacRequest.VaultHmacRequestBuilder	Builder to build a VaultHmacRequest.

Method Summary

Modifier and Type	Method	Description
static VaultHmacRequest.VaultHmacRequestBuilder	builder()
static VaultHmacRequest	create(Plaintext input)	Create a new VaultHmacRequest given Plaintext.
@Nullable String	getAlgorithm()
@Nullable Integer	getKeyVersion()
Plaintext	getPlaintext()

Methods inherited from class java.lang.Object

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

Method Details

builder

public static VaultHmacRequest.VaultHmacRequestBuilder builder()

Returns:

a new instance of VaultHmacRequest.VaultHmacRequestBuilder.

create

public static VaultHmacRequest create(Plaintext input)

Create a new VaultHmacRequest given Plaintext. Uses the default signature algorithm.

Returns:

a new VaultHmacRequest for the given input.

getPlaintext

public Plaintext getPlaintext()

Returns:

plain text input used as basis to generate the digest.

getAlgorithm

public @Nullable String getAlgorithm()

Returns:

algorithm used for creating the digest or null to use the default algorithm.

getKeyVersion

public @Nullable Integer getKeyVersion()

Returns:

version of the key used or null to use the the latest version.