Record Class SigningRequest

java.lang.Object

java.lang.Record

zeroecho.pki.api.signing.SigningRequest

Record Components:

submissionId - caller-reserved operation identity

accessContext - trusted authorization and audit context

keyRef - authorized provider key reference

fairnessAuthorityId - durable scheduling authority identity

signatureAlgorithm - exact signature identity; the service enforces its security floor and provider support before staging

candidateEncoding - encoding of staged candidate bytes

signatureEncoding - requested signature encoding; currently BINARY

public record SigningRequest(SigningSubmissionId submissionId, AccessContext accessContext, KeyRef keyRef, PkiId fairnessAuthorityId, AlgorithmIdentity signatureAlgorithm, Encoding candidateEncoding, Encoding signatureEncoding)
extends Record

Immutable privileged input for one sign-only operation.

Constructor Summary

Constructors

Constructor	Description
SigningRequest(SigningSubmissionId submissionId, AccessContext accessContext, KeyRef keyRef, PkiId fairnessAuthorityId, AlgorithmIdentity signatureAlgorithm, Encoding candidateEncoding, Encoding signatureEncoding)	Validates required components and the signature identity's semantic kind.

Method Summary

Modifier and Type	Method	Description
AccessContext	accessContext()	Returns the value of the accessContext record component.
Encoding	candidateEncoding()	Returns the value of the candidateEncoding record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
PkiId	fairnessAuthorityId()	Returns the value of the fairnessAuthorityId record component.
final int	hashCode()	Returns a hash code value for this object.
KeyRef	keyRef()	Returns the value of the keyRef record component.
AlgorithmIdentity	signatureAlgorithm()	Returns the value of the signatureAlgorithm record component.
Encoding	signatureEncoding()	Returns the value of the signatureEncoding record component.
SigningSubmissionId	submissionId()	Returns the value of the submissionId record component.
String	toString()	Returns a representation that omits privileged request metadata.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SigningRequest

public SigningRequest(SigningSubmissionId submissionId,
 AccessContext accessContext,
 KeyRef keyRef,
 PkiId fairnessAuthorityId,
 AlgorithmIdentity signatureAlgorithm,
 Encoding candidateEncoding,
 Encoding signatureEncoding)

Validates required components and the signature identity's semantic kind. Provider support and the PKI security floor are checked by preparation.

Throws:

NullPointerException - if a component is null

IllegalArgumentException - if the identity is not a signature or the signature encoding is not BINARY

Method Details

toString

public String toString()

Returns a representation that omits privileged request metadata.

Specified by:

toString in class Record

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.

submissionId

public SigningSubmissionId submissionId()

Returns the value of the submissionId record component.

Returns:

the value of the submissionId record component

accessContext

public AccessContext accessContext()

Returns the value of the accessContext record component.

Returns:

the value of the accessContext record component

keyRef

public KeyRef keyRef()

Returns the value of the keyRef record component.

Returns:

the value of the keyRef record component

fairnessAuthorityId

public PkiId fairnessAuthorityId()

Returns the value of the fairnessAuthorityId record component.

Returns:

the value of the fairnessAuthorityId record component

signatureAlgorithm

public AlgorithmIdentity signatureAlgorithm()

Returns the value of the signatureAlgorithm record component.

Returns:

the value of the signatureAlgorithm record component

candidateEncoding

public Encoding candidateEncoding()

Returns the value of the candidateEncoding record component.

Returns:

the value of the candidateEncoding record component

signatureEncoding

public Encoding signatureEncoding()

Returns the value of the signatureEncoding record component.

Returns:

the value of the signatureEncoding record component