Package co.cryptoservice.sdk
Record Class KdfRequest
java.lang.Object
java.lang.Record
co.cryptoservice.sdk.KdfRequest
- Record Components:
algorithm- the algorithmpassword- the passwordsalt- the salt as hex, or null for a random onekeyLength- the derived key length in bytes, or null for the defaultparams- the parameters
public record KdfRequest(KdfAlgorithm algorithm, String password, String salt, Double keyLength, KdfParams params)
extends Record
The body of
POST /v2/kdf.-
Constructor Summary
ConstructorsConstructorDescriptionKdfRequest(KdfAlgorithm algorithm, String password, String salt, Double keyLength, KdfParams params) Checks that every required member is present. -
Method Summary
Modifier and TypeMethodDescriptionReturns the value of thealgorithmrecord component.final booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.Returns the value of thekeyLengthrecord component.static KdfRequestof(KdfAlgorithm algorithm, String password) A request with only the required members; the optional ones are null.params()Returns the value of theparamsrecord component.password()Returns the value of thepasswordrecord component.salt()Returns the value of thesaltrecord component.toString()Names the members; values that may be secret (keys, plaintexts, passwords, signatures) are redacted.withKeyLength(Double keyLength) A copy withkeyLengthreplaced.withParams(KdfParams params) A copy withparamsreplaced.A copy withsaltreplaced.
-
Constructor Details
-
KdfRequest
public KdfRequest(KdfAlgorithm algorithm, String password, String salt, Double keyLength, KdfParams params) Checks that every required member is present.- Throws:
NullPointerException- when a required member is null
-
-
Method Details
-
of
A request with only the required members; the optional ones are null.- Parameters:
algorithm- the algorithmpassword- the password- Returns:
- the request
-
withSalt
A copy withsaltreplaced.- Parameters:
salt- the salt as hex, or null for a random one- Returns:
- the new request
-
withKeyLength
A copy withkeyLengthreplaced.- Parameters:
keyLength- the derived key length in bytes, or null for the default- Returns:
- the new request
-
withParams
A copy withparamsreplaced.- Parameters:
params- the parameters- Returns:
- the new request
-
toString
Names the members; values that may be secret (keys, plaintexts, passwords, signatures) are redacted. -
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. -
equals
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 withObjects::equals(Object,Object). -
algorithm
Returns the value of thealgorithmrecord component.- Returns:
- the value of the
algorithmrecord component
-
password
Returns the value of thepasswordrecord component.- Returns:
- the value of the
passwordrecord component
-
salt
Returns the value of thesaltrecord component.- Returns:
- the value of the
saltrecord component
-
keyLength
Returns the value of thekeyLengthrecord component.- Returns:
- the value of the
keyLengthrecord component
-
params
Returns the value of theparamsrecord component.- Returns:
- the value of the
paramsrecord component
-