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

Class EncryptBatch.Request

java.lang.Object
io.helidon.integrations.common.rest.ApiJsonBuilder<EncryptBatch.Request>
io.helidon.integrations.common.rest.ApiJsonRequest<EncryptBatch.Request>
io.helidon.integrations.vault.VaultRequest<EncryptBatch.Request>
io.helidon.integrations.vault.secrets.transit.EncryptBatch.Request
All Implemented Interfaces:
ApiRequest<EncryptBatch.Request>
Enclosing class:
EncryptBatch
public static class EncryptBatch.Request extends VaultRequest<EncryptBatch.Request>
Request object. Can be configured with additional headers, query parameters etc.

  • Method Details

    • builder

      public static EncryptBatch.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

    • encryptionKeyName

      public EncryptBatch.Request encryptionKeyName(String encryptionKeyName)
      Specifies the name of the encryption key to encrypt against. Required.
      Parameters:
      encryptionKeyName - name of the key
      Returns:
      updated request

    • encryptionKeyVersion

      public EncryptBatch.Request encryptionKeyVersion(int version)
      Specifies the version of the key to use for encryption. 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

    • encryptionKeyType

      public EncryptBatch.Request encryptionKeyType(String type)
      This parameter is required when encryption key is expected to be created. When performing an upsert operation, the type of key to create.

      Defaults to aes256-gcm96.

      Parameters:
      type - type of the encryption key
      Returns:
      updated request

    • convergentEncryption

      public EncryptBatch.Request convergentEncryption(String convergent)
      This parameter will only be used when a key is expected to be created. Whether to support convergent encryption. This is only supported when using a key with key derivation enabled and will require all requests to carry both a context and 96-bit (12-byte) nonce. The given nonce will be used in place of a randomly generated nonce. As a result, when the same context and nonce are supplied, the same ciphertext is generated. It is very important when using this mode that you ensure that all nonces are unique for a given context. Failing to do so will severely impact the ciphertext's security.
      Parameters:
      convergent - convergent encryption
      Returns:
      updated request

    • addEntry

      public EncryptBatch.Request addEntry(EncryptBatch.BatchEntry batch)
      Specifies a list of items to be encrypted in a single batch. When this parameter is set, if the parameters 'plaintext', 'context' and 'nonce' are also set, they will be ignored.
      Parameters:
      batch - batch to encrypt
      Returns:
      updated request