Record Class ServerOperationGateway.Request

java.lang.Object

java.lang.Record

zeroecho.pki.server.ServerOperationGateway.Request

Record Components:

realmId - exact realm identity

principalId - authenticated end-client principal identity

authenticationMode - explicit administrative authentication mode

transportPrincipalId - trusted proxy identity, present only in proxy mode

credentialEvidence - trusted end-client credential evidence, never operation data

operation - existing typed operation

resource - exact non-bearer resource reference

relationship - established object relationship

context - safe closed-condition context

approvalId - optional durable approval reference

correlationId - safe finite request correlation identity

Enclosing class:

ServerOperationGateway

public static record ServerOperationGateway.Request(RealmId realmId, String principalId, AdministrativeAuthenticationMode authenticationMode, Optional<String> transportPrincipalId, Optional<CertificateIdentityEvidence> credentialEvidence, AdministrativeOperation operation, Permission.Resource resource, Permission.Relationship relationship, Permission.Context context, Optional<String> approvalId, String correlationId)
extends Record

Complete transport-neutral request admission input.

Constructor Summary

Constructors

Constructor	Description
Request(RealmId realmId, String principalId, PkiOperation operation, Permission.Resource resource, Permission.Relationship relationship, Permission.Context context, Optional<String> approvalId, String correlationId)	Wraps an existing PKI operation for source-compatible embedded callers.
Request(RealmId realmId, String principalId, AdministrativeAuthenticationMode authenticationMode, Optional<String> transportPrincipalId, Optional<CertificateIdentityEvidence> credentialEvidence, AdministrativeOperation operation, Permission.Resource resource, Permission.Relationship relationship, Permission.Context context, Optional<String> approvalId, String correlationId)	Validates the immutable request.
Request(RealmId realmId, String principalId, AdministrativeAuthenticationMode authenticationMode, Optional<String> transportPrincipalId, AdministrativeOperation operation, Permission.Resource resource, Permission.Relationship relationship, Permission.Context context, Optional<String> approvalId, String correlationId)	Creates an embedded request with no enrollment credential evidence.
Request(RealmId realmId, String principalId, AdministrativeOperation operation, Permission.Resource resource, Permission.Relationship relationship, Permission.Context context, Optional<String> approvalId, String correlationId)	Creates a direct-mTLS request for existing embedded control callers.

Method Summary

Modifier and Type	Method	Description
Optional<String>	approvalId()	Returns the value of the approvalId record component.
AdministrativeAuthenticationMode	authenticationMode()	Returns the value of the authenticationMode record component.
Permission.Context	context()	Returns the value of the context record component.
String	correlationId()	Returns the value of the correlationId record component.
Optional<CertificateIdentityEvidence>	credentialEvidence()	Returns the value of the credentialEvidence 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.
AdministrativeOperation	operation()	Returns the value of the operation record component.
String	principalId()	Returns the value of the principalId record component.
RealmId	realmId()	Returns the value of the realmId record component.
Permission.Relationship	relationship()	Returns the value of the relationship record component.
Permission.Resource	resource()	Returns the value of the resource record component.
final String	toString()	Returns a string representation of this record class.
Optional<String>	transportPrincipalId()	Returns the value of the transportPrincipalId record component.

Methods inherited from class Object

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

Constructor Details

Request

public Request(RealmId realmId,
 String principalId,
 AdministrativeAuthenticationMode authenticationMode,
 Optional<String> transportPrincipalId,
 Optional<CertificateIdentityEvidence> credentialEvidence,
 AdministrativeOperation operation,
 Permission.Resource resource,
 Permission.Relationship relationship,
 Permission.Context context,
 Optional<String> approvalId,
 String correlationId)

Validates the immutable request.

Request

public Request(RealmId realmId,
 String principalId,
 PkiOperation operation,
 Permission.Resource resource,
 Permission.Relationship relationship,
 Permission.Context context,
 Optional<String> approvalId,
 String correlationId)

Wraps an existing PKI operation for source-compatible embedded callers.

Parameters:

realmId - target realm

principalId - authenticated principal identifier

operation - exact typed PKI operation

resource - exact target resource

relationship - requester-to-resource relationship

context - closed authorization context

approvalId - optional execution approval

correlationId - bounded non-secret request correlation identifier

Request

public Request(RealmId realmId,
 String principalId,
 AdministrativeOperation operation,
 Permission.Resource resource,
 Permission.Relationship relationship,
 Permission.Context context,
 Optional<String> approvalId,
 String correlationId)

Creates a direct-mTLS request for existing embedded control callers.

Parameters:

realmId - target realm

principalId - authenticated principal identifier

operation - exact typed administrative operation

resource - exact target resource

relationship - requester-to-resource relationship

context - closed authorization context

approvalId - optional execution approval

correlationId - bounded non-secret request correlation identifier

Request

public Request(RealmId realmId,
 String principalId,
 AdministrativeAuthenticationMode authenticationMode,
 Optional<String> transportPrincipalId,
 AdministrativeOperation operation,
 Permission.Resource resource,
 Permission.Relationship relationship,
 Permission.Context context,
 Optional<String> approvalId,
 String correlationId)

Creates an embedded request with no enrollment credential evidence.

Parameters:

realmId - exact target realm

principalId - authenticated principal

authenticationMode - administrative topology

transportPrincipalId - trusted proxy identity when applicable

operation - typed operation

resource - authorized resource coordinates

relationship - requester relationship

context - closed authorization context

approvalId - optional approval identity

correlationId - bounded request correlation identity

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.

realmId

public RealmId realmId()

Returns the value of the realmId record component.

Returns:

the value of the realmId record component

principalId

public String principalId()

Returns the value of the principalId record component.

Returns:

the value of the principalId record component

authenticationMode

public AdministrativeAuthenticationMode authenticationMode()

Returns the value of the authenticationMode record component.

Returns:

the value of the authenticationMode record component

transportPrincipalId

public Optional<String> transportPrincipalId()

Returns the value of the transportPrincipalId record component.

Returns:

the value of the transportPrincipalId record component

credentialEvidence

public Optional<CertificateIdentityEvidence> credentialEvidence()

Returns the value of the credentialEvidence record component.

Returns:

the value of the credentialEvidence record component

operation

public AdministrativeOperation operation()

Returns the value of the operation record component.

Returns:

the value of the operation record component

resource

public Permission.Resource resource()

Returns the value of the resource record component.

Returns:

the value of the resource record component

relationship

public Permission.Relationship relationship()

Returns the value of the relationship record component.

Returns:

the value of the relationship record component

context

public Permission.Context context()

Returns the value of the context record component.

Returns:

the value of the context record component

approvalId

public Optional<String> approvalId()

Returns the value of the approvalId record component.

Returns:

the value of the approvalId record component

correlationId

public String correlationId()

Returns the value of the correlationId record component.

Returns:

the value of the correlationId record component