Record Class HpkeOpenResult

java.lang.Object
java.lang.Record
co.cryptoservice.sdk.HpkeOpenResult
Record Components:
hex - the decrypted bytes; lowercase hex
plaintext - the decrypted bytes, decoded as UTF-8 (invalid sequences become U+FFFD); UTF-8 text

public record HpkeOpenResult(String hex, String plaintext) extends Record
What POST /v2/hpke/open answers: decrypt (open) an HPKE ciphertext with a server-held key.
  • Constructor Summary

    Constructors
    Constructor
    Description
    HpkeOpenResult(String hex, String plaintext)
    Creates an instance of a HpkeOpenResult record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    hex()
    Returns the value of the hex record component.
    byte[]
    hex() decoded from hex.
    Returns the value of the plaintext record component.
    Names the members; values that may be secret (keys, plaintexts, passwords, signatures) are redacted.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • HpkeOpenResult

      public HpkeOpenResult(String hex, String plaintext)
      Creates an instance of a HpkeOpenResult record class.
      Parameters:
      hex - the value for the hex record component
      plaintext - the value for the plaintext record component
  • Method Details

    • hexBytes

      public byte[] hexBytes()
      hex() decoded from hex.
      Returns:
      the bytes, or null when hex is absent
      Throws:
      IllegalArgumentException - when the server sent malformed hex
    • toString

      public String toString()
      Names the members; values that may be secret (keys, plaintexts, passwords, signatures) are redacted.
      Specified by:
      toString in class Record
      Returns:
      a description safe to log
    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object
    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.
    • hex

      public String hex()
      Returns the value of the hex record component.
      Returns:
      the value of the hex record component
    • plaintext

      public String plaintext()
      Returns the value of the plaintext record component.
      Returns:
      the value of the plaintext record component