Module io.helidon.integrations.vault.secrets.transit

Package io.helidon.integrations.vault.secrets.transit

Class Hmac.Request

java.lang.Object

io.helidon.integrations.common.rest.ApiJsonBuilder<Hmac.Request>

io.helidon.integrations.common.rest.ApiJsonRequest<Hmac.Request>

io.helidon.integrations.vault.VaultRequest<Hmac.Request>

io.helidon.integrations.vault.secrets.transit.Hmac.Request

All Implemented Interfaces:

ApiRequest<Hmac.Request>

Enclosing class:

Hmac

public static class Hmac.Request
extends VaultRequest<Hmac.Request>

Request object. Can be configured with additional headers, query parameters etc.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HASH_ALGORITHM_SHA2_224	Hash algorithm "sha2-224".
static final String	HASH_ALGORITHM_SHA2_256	Hash algorithm "sha2-256".
static final String	HASH_ALGORITHM_SHA2_384	Hash algorithm "sha2-384".
static final String	HASH_ALGORITHM_SHA2_512	Hash algorithm "sha2-512".

Method Summary

Modifier and Type	Method	Description
static Hmac.Request	builder()	Fluent API builder for configuring a request.
Hmac.Request	data(Base64Value value)	The data to sign.
Hmac.Request	hashAlgorithm(String hashAlgorithm)	Specifies the hash algorithm to use for supporting key types (notably, not including ed25519 which specifies its own hash algorithm).
Hmac.Request	hmacKeyName(String signatureKeyName)	Specifies the name of the encryption key to sign against.
Hmac.Request	hmacKeyVersion(int version)	Specifies the version of the key to use for signatures.

Methods inherited from class io.helidon.integrations.vault.VaultRequest

add, addCommaDelimitedArray, addToCommaDelimitedArray, durationToTtl, preBuild

Methods inherited from class io.helidon.integrations.common.rest.ApiJsonRequest

addHeader, addQueryParam, headers, queryParams, requestId, requestId, requestMediaType, requestMediaType, responseMediaType, responseMediaType

Methods inherited from class io.helidon.integrations.common.rest.ApiJsonBuilder

add, add, add, add, add, add, addBase64, addToArray, addToArray, addToArray, addToArray, addToArray, addToArray, addToObject, addToObject, addToObject, addToObject, addToObject, emptyArray, me, postBuild, toJson

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.integrations.common.rest.ApiRequest

toJson

Field Details

HASH_ALGORITHM_SHA2_224

public static final String HASH_ALGORITHM_SHA2_224

Hash algorithm "sha2-224".

See Also:

• hashAlgorithm(String)
• Constant Field Values

HASH_ALGORITHM_SHA2_256

public static final String HASH_ALGORITHM_SHA2_256

Hash algorithm "sha2-256".

See Also:

• hashAlgorithm(String)
• Constant Field Values

HASH_ALGORITHM_SHA2_384

public static final String HASH_ALGORITHM_SHA2_384

Hash algorithm "sha2-384".

See Also:

• hashAlgorithm(String)
• Constant Field Values

HASH_ALGORITHM_SHA2_512

public static final String HASH_ALGORITHM_SHA2_512

Hash algorithm "sha2-512".

See Also:

• hashAlgorithm(String)
• Constant Field Values

Method Details

builder

public static Hmac.Request builder()

Fluent API builder for configuring a request. The request builder is passed as is, without a build method. The equivalent of a build method is ApiJsonBuilder.toJson(jakarta.json.JsonBuilderFactory) used by the RestApi.

Returns:

new request builder

hmacKeyName

public Hmac.Request hmacKeyName(String signatureKeyName)

Specifies the name of the encryption key to sign against. Required.

Parameters:

signatureKeyName - name of the key

Returns:

updated request

hmacKeyVersion

public Hmac.Request hmacKeyVersion(int version)

Specifies the version of the key to use for signatures. If not set, uses the latest version. Must be greater than or equal to the key's min_encryption_version, if set. Optional.

Parameters:

version - key version

Returns:

updated request

data

public Hmac.Request data(Base64Value value)

The data to sign.

Parameters:

value - value to encrypt

Returns:

updated request

See Also:

• Base64Value.create(String)
• Base64Value.create(byte[])

hashAlgorithm

public Hmac.Request hashAlgorithm(String hashAlgorithm)

Specifies the hash algorithm to use for supporting key types (notably, not including ed25519 which specifies its own hash algorithm). See hash algorithm constants on this class.

Parameters:

hashAlgorithm - algorithm to use

Returns:

updated request