Record Class CmpEndpoint

java.lang.Object

java.lang.Record

zeroecho.pki.server.cmp.CmpEndpoint

Record Components:

label - URL-safe identifier, 1–64 characters, matching [A-Za-z0-9._-]+

authorityId - the CA authority identifier whose chain is served on this endpoint

profileId - the issuance profile identifier applied to enrollment requests

enrollmentProfileId - mandatory enrollment policy identity, distinct from the issuance profile

protectionPolicy - the PKIMessage protection policy required for this endpoint

All Implemented Interfaces:

EnrollmentEndpoint

public record CmpEndpoint(String label, String authorityId, String profileId, String enrollmentProfileId, CmpProtectionPolicy protectionPolicy)
extends Record
implements EnrollmentEndpoint

Immutable binding that maps a CMP path suffix to a CA authority, an issuance profile, and a required PKIMessage protection policy.

Endpoints are registered and de-registered via the admin API and held in the CmpService endpoint registry. The label value appears in the CMP URL path under /pkix/{label}.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_LABEL_LENGTH	Maximum permitted label length.

Constructor Summary

Constructors

Constructor	Description
CmpEndpoint(String label, String authorityId, String profileId, String enrollmentProfileId, CmpProtectionPolicy protectionPolicy)	Validates all fields.

Method Summary

Modifier and Type	Method	Description
String	authorityId()	Returns the value of the authorityId record component.
String	enrollmentProfileId()	Returns the value of the enrollmentProfileId record component.
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.
String	label()	Returns the value of the label record component.
String	profileId()	Returns the value of the profileId record component.
CmpProtectionPolicy	protectionPolicy()	Returns the value of the protectionPolicy record component.
final 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

MAX_LABEL_LENGTH

public static final int MAX_LABEL_LENGTH

Maximum permitted label length.

See Also:

• Constant Field Values

Constructor Details

CmpEndpoint

public CmpEndpoint(String label,
 String authorityId,
 String profileId,
 String enrollmentProfileId,
 CmpProtectionPolicy protectionPolicy)

Validates all fields.

Method Details

toString

public final 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.

label

public String label()

Returns the value of the label record component.

Specified by:

label in interface EnrollmentEndpoint

Returns:

the value of the label record component

authorityId

public String authorityId()

Returns the value of the authorityId record component.

Specified by:

authorityId in interface EnrollmentEndpoint

Returns:

the value of the authorityId record component

profileId

public String profileId()

Returns the value of the profileId record component.

Specified by:

profileId in interface EnrollmentEndpoint

Returns:

the value of the profileId record component

enrollmentProfileId

public String enrollmentProfileId()

Returns the value of the enrollmentProfileId record component.

Specified by:

enrollmentProfileId in interface EnrollmentEndpoint

Returns:

the value of the enrollmentProfileId record component

protectionPolicy

public CmpProtectionPolicy protectionPolicy()

Returns the value of the protectionPolicy record component.

Returns:

the value of the protectionPolicy record component