Record Class EnrollmentRuntimeConfiguration

java.lang.Object

java.lang.Record

zeroecho.pki.server.enrollment.EnrollmentRuntimeConfiguration

Record Components:

budgets - explicit transaction admission limits

keyrings - dedicated encrypted keyring owners

credentialSets - immutable, authority-scoped current and retained credentials

activeCredentials - unique selections for new protocol transactions

keygenArtifacts - optional encrypted delivery artifact capability

public record EnrollmentRuntimeConfiguration(EnrollmentRuntimeConfiguration.Budgets budgets, List<EnrollmentRuntimeConfiguration.Keyring> keyrings, List<EnrollmentRuntimeConfiguration.CredentialSet> credentialSets, List<EnrollmentRuntimeConfiguration.ActiveCredential> activeCredentials, Optional<EnrollmentRuntimeConfiguration.KeygenArtifacts> keygenArtifacts)
extends Record

Immutable, separately versioned enrollment resource and credential configuration. No capability or resource budget is enabled implicitly. Certificate paths name single DER certificates, and encrypted keyring paths must already exist.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	EnrollmentRuntimeConfiguration.ActiveCredential	Selection for newly admitted transactions; retained transactions keep their ID.
static final record	EnrollmentRuntimeConfiguration.Budgets	Explicit transaction budgets, including terminal replay records.
static final record	EnrollmentRuntimeConfiguration.CredentialSet	Immutable authority-scoped protocol credentials.
static final record	EnrollmentRuntimeConfiguration.KeygenArtifacts	Optional client-encrypted server-keygen delivery storage.
static final record	EnrollmentRuntimeConfiguration.KeyReference	Reference to existing material in a configured encrypted keyring.
static final record	EnrollmentRuntimeConfiguration.Keyring	Dedicated, preprovisioned encrypted keyring.
static final record	EnrollmentRuntimeConfiguration.Pbm	Explicit CMP PBM work, salt and algorithm limits.
static enum	EnrollmentRuntimeConfiguration.PbmDigest	Explicitly supported PBM digest families.
static final record	EnrollmentRuntimeConfiguration.PbmIdentity	One CMP PBM requester, isolated to this credential set and authority.
static enum	EnrollmentRuntimeConfiguration.PbmMac	Explicitly supported PBM MAC families.
static enum	EnrollmentRuntimeConfiguration.Protocol	Protocols requiring explicitly provisioned message credentials.
static final record	EnrollmentRuntimeConfiguration.Signer	Response signer with a leaf-to-anchor DER certificate chain.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	VERSION	Current companion configuration version; independent of server schema 8.

Constructor Summary

Constructors

Constructor	Description
EnrollmentRuntimeConfiguration(EnrollmentRuntimeConfiguration.Budgets budgets, List<EnrollmentRuntimeConfiguration.Keyring> keyrings, List<EnrollmentRuntimeConfiguration.CredentialSet> credentialSets, List<EnrollmentRuntimeConfiguration.ActiveCredential> activeCredentials, Optional<EnrollmentRuntimeConfiguration.KeygenArtifacts> keygenArtifacts)	Validates bounded collections and every cross-reference.

Method Summary

Modifier and Type	Method	Description
List<EnrollmentRuntimeConfiguration.ActiveCredential>	activeCredentials()	Returns the value of the activeCredentials record component.
EnrollmentRuntimeConfiguration.Budgets	budgets()	Returns the value of the budgets record component.
List<EnrollmentRuntimeConfiguration.CredentialSet>	credentialSets()	Returns the value of the credentialSets record component.
static EnrollmentRuntimeConfiguration	decode(byte[] bytes)	Decodes a closed version-one JSON document, at most 1 MiB.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
Optional<EnrollmentRuntimeConfiguration.KeygenArtifacts>	keygenArtifacts()	Returns the value of the keygenArtifacts record component.
List<EnrollmentRuntimeConfiguration.Keyring>	keyrings()	Returns the value of the keyrings record component.
static EnrollmentRuntimeConfiguration	read(Path path)	Reads a bounded strict UTF-8 companion document.
String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Field Details

VERSION

public static final int VERSION

Current companion configuration version; independent of server schema 8.

See Also:

• Constant Field Values

Constructor Details

EnrollmentRuntimeConfiguration

public EnrollmentRuntimeConfiguration(EnrollmentRuntimeConfiguration.Budgets budgets,
 List<EnrollmentRuntimeConfiguration.Keyring> keyrings,
 List<EnrollmentRuntimeConfiguration.CredentialSet> credentialSets,
 List<EnrollmentRuntimeConfiguration.ActiveCredential> activeCredentials,
 Optional<EnrollmentRuntimeConfiguration.KeygenArtifacts> keygenArtifacts)

Validates bounded collections and every cross-reference.

Method Details

read

public static EnrollmentRuntimeConfiguration read(Path path)
                                           throws IOException

Reads a bounded strict UTF-8 companion document.

Parameters:

path - document path

Returns:

immutable validated configuration

Throws:

IOException - if reading fails

IllegalArgumentException - if the document is invalid

decode

public static EnrollmentRuntimeConfiguration decode(byte[] bytes)

Decodes a closed version-one JSON document, at most 1 MiB.

Parameters:

bytes - exact UTF-8 document

Returns:

immutable validated configuration

Throws:

IllegalArgumentException - if the document is invalid

toString

public String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

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.

budgets

public EnrollmentRuntimeConfiguration.Budgets budgets()

Returns the value of the budgets record component.

Returns:

the value of the budgets record component

keyrings

public List<EnrollmentRuntimeConfiguration.Keyring> keyrings()

Returns the value of the keyrings record component.

Returns:

the value of the keyrings record component

credentialSets

public List<EnrollmentRuntimeConfiguration.CredentialSet> credentialSets()

Returns the value of the credentialSets record component.

Returns:

the value of the credentialSets record component

activeCredentials

public List<EnrollmentRuntimeConfiguration.ActiveCredential> activeCredentials()

Returns the value of the activeCredentials record component.

Returns:

the value of the activeCredentials record component

keygenArtifacts

public Optional<EnrollmentRuntimeConfiguration.KeygenArtifacts> keygenArtifacts()

Returns the value of the keygenArtifacts record component.

Returns:

the value of the keygenArtifacts record component