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 Details

    • ALGORITHM_SHA_224_RSA_PKCS_PSS

      public static final String ALGORITHM_SHA_224_RSA_PKCS_PSS
      "SHA_224_RSA_PKCS_PSS" algorithm.
      See Also:
    • ALGORITHM_SHA_256_RSA_PKCS_PSS

      public static final String ALGORITHM_SHA_256_RSA_PKCS_PSS
      "SHA_256_RSA_PKCS_PSS" algorithm.
      See Also:
    • ALGORITHM_SHA_384_RSA_PKCS_PSS

      public static final String ALGORITHM_SHA_384_RSA_PKCS_PSS
      "SHA_384_RSA_PKCS_PSS" algorithm.
      See Also:
    • ALGORITHM_SHA_512_RSA_PKCS_PSS

      public static final String ALGORITHM_SHA_512_RSA_PKCS_PSS
      "SHA_512_RSA_PKCS_PSS" algorithm.
      See Also:
    • 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:
    • 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:
    • 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:
    • 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:
    • ALGORITHM_ECDSA_SHA_256

      public static final String ALGORITHM_ECDSA_SHA_256
      "ECDSA_SHA_256" algorithm.
      See Also:
    • ALGORITHM_ECDSA_SHA_384

      public static final String ALGORITHM_ECDSA_SHA_384
      "ECDSA_SHA_384" algorithm.
      See Also:
    • ALGORITHM_ECDSA_SHA_512

      public static final String ALGORITHM_ECDSA_SHA_512
      "ECDSA_SHA_512" algorithm.
      See Also:
    • MESSAGE_TYPE_RAW

      public static final String MESSAGE_TYPE_RAW
      Raw message.
      See Also:
    • MESSAGE_TYPE_DIGEST

      public static final String MESSAGE_TYPE_DIGEST
      Digest of a message.
      See Also:
  • Method Details

    • 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(jakarta.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:
    • 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:
    • 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