com.quorum.tessera.api.PayloadEncryptResponse Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of common-jaxrs Show documentation
Tessera is a stateless Java system that is used to enable the encryption, decryption, and distribution of private transactions for Quorum.
There is a newer version: 24.4.2
Show newest version
package com.quorum.tessera.api;

import com.quorum.tessera.config.adapters.MapAdapter;
import io.swagger.v3.oas.annotations.media.ArraySchema;
import io.swagger.v3.oas.annotations.media.Schema;
import jakarta.xml.bind.annotation.*;
import jakarta.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
import java.util.List;
import java.util.Map;

@XmlRootElement
@XmlAccessorType(XmlAccessType.FIELD)
public class PayloadEncryptResponse {

  @Schema(
      description = "public key identifying the sender of the payload",
      type = "string",
      format = "base64")
  @XmlElement
  @XmlMimeType("base64Binary")
  private byte[] senderKey;

  @Schema(description = "encrypted data", type = "string", format = "base64")
  @XmlElement
  @XmlMimeType("base64Binary")
  private byte[] cipherText;

  @Schema(description = "nonce used in data encryption", type = "string", format = "base64")
  @XmlElement
  @XmlMimeType("base64Binary")
  private byte[] cipherTextNonce;

  @ArraySchema(
      arraySchema =
          @Schema(
              description =
                  "master key used in data encryption, wrapped for each payload recipient"),
      schema = @Schema(type = "string", format = "base64"))
  @XmlElement
  @XmlMimeType("base64Binary")
  private List recipientBoxes;

  @Schema(description = "nonce used in master encryption", type = "string", format = "base64")
  @XmlElement
  @XmlMimeType("base64Binary")
  private byte[] recipientNonce;

  @ArraySchema(
      arraySchema = @Schema(description = "public keys identifying each recipient of the payload"),
      schema = @Schema(type = "string", format = "base64"))
  @XmlElement
  @XmlMimeType("base64Binary")
  private List recipientKeys;

  @Schema(
      description =
          "the privacy mode of the transaction\n* 0 = standard private\n* 1 = party protection\n* 3 = private-state validation",
      allowableValues = {"0", "1", "3"})
  @XmlElement
  private int privacyMode;

  @Schema(
      description =
          "mapping of encoded payload hashes (base64 encoded) to security hashes (base64 encoded)",
      format = "Map")
  @XmlElement
  @XmlJavaTypeAdapter(MapAdapter.class)
  private Map affectedContractTransactions;

  @Schema(
      description = "execution hash; merkle root of all affected contracts after tx simulation",
      type = "string",
      format = "base64")
  @XmlElement
  @XmlMimeType("base64Binary")
  private byte[] execHash;

  public byte[] getSenderKey() {
    return senderKey;
  }

  public void setSenderKey(byte[] senderKey) {
    this.senderKey = senderKey;
  }

  public byte[] getCipherText() {
    return cipherText;
  }

  public void setCipherText(byte[] cipherText) {
    this.cipherText = cipherText;
  }

  public byte[] getCipherTextNonce() {
    return cipherTextNonce;
  }

  public void setCipherTextNonce(byte[] cipherTextNonce) {
    this.cipherTextNonce = cipherTextNonce;
  }

  public List getRecipientBoxes() {
    return recipientBoxes;
  }

  public void setRecipientBoxes(List recipientBoxes) {
    this.recipientBoxes = recipientBoxes;
  }

  public byte[] getRecipientNonce() {
    return recipientNonce;
  }

  public void setRecipientNonce(byte[] recipientNonce) {
    this.recipientNonce = recipientNonce;
  }

  public List getRecipientKeys() {
    return recipientKeys;
  }

  public void setRecipientKeys(List recipientKeys) {
    this.recipientKeys = recipientKeys;
  }

  public int getPrivacyMode() {
    return privacyMode;
  }

  public void setPrivacyMode(int privacyMode) {
    this.privacyMode = privacyMode;
  }

  public Map getAffectedContractTransactions() {
    return affectedContractTransactions;
  }

  public void setAffectedContractTransactions(Map affectedContractTransactions) {
    this.affectedContractTransactions = affectedContractTransactions;
  }

  public byte[] getExecHash() {
    return execHash;
  }

  public void setExecHash(byte[] execHash) {
    this.execHash = execHash;
  }
}