Record Class SecretboxOpenRequest

java.lang.Object
java.lang.Record
co.cryptoservice.sdk.SecretboxOpenRequest
Record Components:
key - the 256-bit key as hex (64 characters)
ciphertext - the ciphertext, as the server returned it
aad - additional authenticated data, or null

public record SecretboxOpenRequest(String key, String ciphertext, String aad) extends Record
The body of POST /v2/secretbox/open.
  • Constructor Details

    • SecretboxOpenRequest

      public SecretboxOpenRequest(String key, String ciphertext, String aad)
      Checks that every required member is present.
      Throws:
      NullPointerException - when a required member is null
  • Method Details

    • of

      public static SecretboxOpenRequest of(String key, String ciphertext)
      A request with only the required members; the optional ones are null.
      Parameters:
      key - the 256-bit key as hex (64 characters)
      ciphertext - the ciphertext, as the server returned it
      Returns:
      the request
    • withAad

      public SecretboxOpenRequest withAad(String aad)
      A copy with aad replaced.
      Parameters:
      aad - additional authenticated data, or null
      Returns:
      the new request
    • 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.
    • key

      public String key()
      Returns the value of the key record component.
      Returns:
      the value of the key record component
    • ciphertext

      public String ciphertext()
      Returns the value of the ciphertext record component.
      Returns:
      the value of the ciphertext record component
    • aad

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