Module io.helidon.integrations.oci.vault

Package io.helidon.integrations.oci.vault

Class Sign.Request

java.lang.Object

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

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

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

io.helidon.integrations.oci.vault.Sign.Request

All Implemented Interfaces:

ApiRequest<Sign.Request>

Enclosing class:

Sign

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static String	ALGORITHM_ECDSA_SHA_256	"ECDSA_SHA_256" algorithm.
static String	ALGORITHM_ECDSA_SHA_384	"ECDSA_SHA_384" algorithm.
static String	ALGORITHM_ECDSA_SHA_512	"ECDSA_SHA_512" algorithm.
static String	ALGORITHM_SHA_224_RSA_PKCS_PSS	"SHA_224_RSA_PKCS_PSS" algorithm.
static String	ALGORITHM_SHA_224_RSA_PKCS1_V1_5	"SHA_224_RSA_PKCS1_V1_5" algorithm.
static String	ALGORITHM_SHA_256_RSA_PKCS_PSS	"SHA_256_RSA_PKCS_PSS" algorithm.
static String	ALGORITHM_SHA_256_RSA_PKCS1_V1_5	"SHA_256_RSA_PKCS1_V1_5" algorithm.
static String	ALGORITHM_SHA_384_RSA_PKCS_PSS	"SHA_384_RSA_PKCS_PSS" algorithm.
static String	ALGORITHM_SHA_384_RSA_PKCS1_V1_5	"SHA_384_RSA_PKCS1_V1_5" algorithm.
static String	ALGORITHM_SHA_512_RSA_PKCS_PSS	"SHA_512_RSA_PKCS_PSS" algorithm.
static String	ALGORITHM_SHA_512_RSA_PKCS1_V1_5	"SHA_512_RSA_PKCS1_V1_5" algorithm.
static String	MESSAGE_TYPE_DIGEST	Digest of a message.
static String	MESSAGE_TYPE_RAW	Raw message.

Method Summary

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

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

Field Detail

ALGORITHM_SHA_224_RSA_PKCS_PSS

public static final String ALGORITHM_SHA_224_RSA_PKCS_PSS

"SHA_224_RSA_PKCS_PSS" algorithm.

See Also:

Constant Field Values

ALGORITHM_SHA_256_RSA_PKCS_PSS

public static final String ALGORITHM_SHA_256_RSA_PKCS_PSS

"SHA_256_RSA_PKCS_PSS" algorithm.

See Also:

Constant Field Values

ALGORITHM_SHA_384_RSA_PKCS_PSS

public static final String ALGORITHM_SHA_384_RSA_PKCS_PSS

"SHA_384_RSA_PKCS_PSS" algorithm.

See Also:

Constant Field Values

ALGORITHM_SHA_512_RSA_PKCS_PSS

public static final String ALGORITHM_SHA_512_RSA_PKCS_PSS

"SHA_512_RSA_PKCS_PSS" algorithm.

See Also:

Constant Field Values

ALGORITHM_SHA_224_RSA_PKCS1_V1_5

public static final String ALGORITHM_SHA_224_RSA_PKCS1_V1_5

"SHA_224_RSA_PKCS1_V1_5" algorithm.

See Also:

Constant Field Values

ALGORITHM_SHA_256_RSA_PKCS1_V1_5

public static final String ALGORITHM_SHA_256_RSA_PKCS1_V1_5

"SHA_256_RSA_PKCS1_V1_5" algorithm.

See Also:

Constant Field Values

ALGORITHM_SHA_384_RSA_PKCS1_V1_5

public static final String ALGORITHM_SHA_384_RSA_PKCS1_V1_5

"SHA_384_RSA_PKCS1_V1_5" algorithm.

See Also:

Constant Field Values

ALGORITHM_SHA_512_RSA_PKCS1_V1_5

public static final String ALGORITHM_SHA_512_RSA_PKCS1_V1_5

"SHA_512_RSA_PKCS1_V1_5" algorithm.

See Also:

Constant Field Values

ALGORITHM_ECDSA_SHA_256

public static final String ALGORITHM_ECDSA_SHA_256

"ECDSA_SHA_256" algorithm.

See Also:

Constant Field Values

ALGORITHM_ECDSA_SHA_384

public static final String ALGORITHM_ECDSA_SHA_384

"ECDSA_SHA_384" algorithm.

See Also:

Constant Field Values

ALGORITHM_ECDSA_SHA_512

public static final String ALGORITHM_ECDSA_SHA_512

"ECDSA_SHA_512" algorithm.

See Also:

Constant Field Values

MESSAGE_TYPE_RAW

public static final String MESSAGE_TYPE_RAW

Raw message.

See Also:

Constant Field Values

MESSAGE_TYPE_DIGEST

public static final String MESSAGE_TYPE_DIGEST

Digest of a message.

See Also:

Constant Field Values

Method Detail

builder

public static Sign.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 Sign.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 sign

Returns:

updated request

See Also:

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

keyId

public Sign.Request keyId(String keyOcid)

The OCID of the key to sign with. Required.

Parameters:

keyOcid - OCID of the key

Returns:

updated request

messageType

public Sign.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:

MESSAGE_TYPE_DIGEST, MESSAGE_TYPE_RAW

algorithm

public Sign.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 this class.

Parameters:

algorithm - algorithm to use

Returns:

updated request

keyVersionId

public Sign.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