Module io.helidon.integrations.oci.vault

Package io.helidon.integrations.oci.vault

Class Verify.Request

java.lang.Object

io.helidon.integrations.common.rest.ApiJsonBuilder<T>

io.helidon.integrations.common.rest.ApiJsonRequest<T>

io.helidon.integrations.oci.connect.OciRequestBase<Verify.Request>

io.helidon.integrations.oci.vault.Verify.Request

All Implemented Interfaces:

ApiRequest<Verify.Request>

Enclosing class:

Verify

public static final class Verify.Request
extends OciRequestBase<Verify.Request>

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

Method Summary

Modifier and Type	Method	Description
Verify.Request	algorithm(String algorithm)	The algorithm to use to sign the message or message digest.
static Verify.Request	builder()	Fluent API builder for configuring a request.
Verify.Request	keyId(String keyOcid)	The OCID of the key to sign with.
Verify.Request	keyVersionId(String versionOcid)	The OCID of the key version used to sing the message.
Verify.Request	message(Base64Value value)	The base64-encoded binary data object denoting the message or message digest to sign.
Verify.Request	messageType(String type)	Denotes whether the value of the message parameter is a raw message or a message digest.
Verify.Request	signature(Base64Value signature)	The base64-encoded binary data object denoting the cryptographic signature generated for the message.

Methods inherited from class io.helidon.integrations.oci.connect.OciRequestBase

add, endpoint, endpoint, hostFormat, hostPrefix, retryToken

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, preBuild, 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

Method Detail

builder

public static Verify.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(javax.json.JsonBuilderFactory) used by the RestApi.

Returns:

new request builder

message

public Verify.Request message(Base64Value value)

The base64-encoded binary data object denoting the message or message digest to sign. You can have a message up to 4096 bytes in size. To sign a larger message, provide the message digest.

Parameters:

value - value to verify

Returns:

updated request

See Also:

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

signature

public Verify.Request signature(Base64Value signature)

The base64-encoded binary data object denoting the cryptographic signature generated for the message.

Parameters:

signature - signature to verify

Returns:

updated request

keyId

public Verify.Request keyId(String keyOcid)

The OCID of the key to sign with. Required.

Parameters:

keyOcid - OCID of the key

Returns:

updated request

messageType

public Verify.Request messageType(String type)

Denotes whether the value of the message parameter is a raw message or a message digest. The default value, RAW, indicates a message. To indicate a message digest, use "DIGEST".

Parameters:

type - type to use

Returns:

updated request

See Also:

Sign.Request.MESSAGE_TYPE_DIGEST, Sign.Request.MESSAGE_TYPE_RAW

algorithm

public Verify.Request algorithm(String algorithm)

The algorithm to use to sign the message or message digest. For RSA keys, supported signature schemes include PKCS #1 and RSASSA-PSS, along with different hashing algorithms. For ECDSA keys, ECDSA is the supported signature scheme with different hashing algorithms. When you pass a message digest for signing, ensure that you specify the same hashing algorithm as used when creating the message digest. Required. See algorithm constants on Sign.Request class.

Parameters:

algorithm - algorithm to use

Returns:

updated request

keyVersionId

public Verify.Request keyVersionId(String versionOcid)

The OCID of the key version used to sing the message. Optional.

Parameters:

versionOcid - OCID of the key version

Returns:

updated request