Record Class KdfRequest

java.lang.Object
java.lang.Record
co.cryptoservice.sdk.KdfRequest
Record Components:
algorithm - the algorithm
password - the password
salt - the salt as hex, or null for a random one
keyLength - the derived key length in bytes, or null for the default
params - the parameters

public record KdfRequest(KdfAlgorithm algorithm, String password, String salt, Double keyLength, KdfParams params) extends Record
The body of POST /v2/kdf.
  • Constructor Details

  • Method Details

    • of

      public static KdfRequest of(KdfAlgorithm algorithm, String password)
      A request with only the required members; the optional ones are null.
      Parameters:
      algorithm - the algorithm
      password - the password
      Returns:
      the request
    • withSalt

      public KdfRequest withSalt(String salt)
      A copy with salt replaced.
      Parameters:
      salt - the salt as hex, or null for a random one
      Returns:
      the new request
    • withKeyLength

      public KdfRequest withKeyLength(Double keyLength)
      A copy with keyLength replaced.
      Parameters:
      keyLength - the derived key length in bytes, or null for the default
      Returns:
      the new request
    • withParams

      public KdfRequest withParams(KdfParams params)
      A copy with params replaced.
      Parameters:
      params - the parameters
      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.
    • algorithm

      public KdfAlgorithm algorithm()
      Returns the value of the algorithm record component.
      Returns:
      the value of the algorithm record component
    • password

      public String password()
      Returns the value of the password record component.
      Returns:
      the value of the password record component
    • salt

      public String salt()
      Returns the value of the salt record component.
      Returns:
      the value of the salt record component
    • keyLength

      public Double keyLength()
      Returns the value of the keyLength record component.
      Returns:
      the value of the keyLength record component
    • params

      public KdfParams params()
      Returns the value of the params record component.
      Returns:
      the value of the params record component