Record Class OperationSecurityDescriptors.Descriptor

java.lang.Object

java.lang.Record

zeroecho.pki.server.OperationSecurityDescriptors.Descriptor

Record Components:

operationId - stable typed-operation identity

family - internally fixed execution family

action - required permission

resourceType - required resource type

mutating - whether the operation may commit state

dataView - required data view

approvalCategory - approval treatment

eligibility - future transport eligibility metadata

Enclosing class:

OperationSecurityDescriptors

public static record OperationSecurityDescriptors.Descriptor(String operationId, OperationSecurityDescriptors.Family family, Permission.Action action, Permission.ResourceType resourceType, boolean mutating, Permission.DataView dataView, OperationSecurityDescriptors.ApprovalCategory approvalCategory, OperationSecurityDescriptors.Eligibility eligibility)
extends Record

Immutable operation security descriptor.

Constructor Summary

Constructors

Constructor	Description
Descriptor(String operationId, OperationSecurityDescriptors.Family family, Permission.Action action, Permission.ResourceType resourceType, boolean mutating, Permission.DataView dataView, OperationSecurityDescriptors.ApprovalCategory approvalCategory, OperationSecurityDescriptors.Eligibility eligibility)	Validates one finite descriptor.
Descriptor(String operationId, Permission.Action action, Permission.ResourceType resourceType, boolean mutating, Permission.DataView dataView, OperationSecurityDescriptors.ApprovalCategory approvalCategory, OperationSecurityDescriptors.Eligibility eligibility)	Creates an existing PKI-family descriptor for embedded callers.

Method Summary

Modifier and Type	Method	Description
Permission.Action	action()	Returns the value of the action record component.
OperationSecurityDescriptors.ApprovalCategory	approvalCategory()	Returns the value of the approvalCategory record component.
boolean	available()	Returns whether this operation may be advertised for execution.
Permission.DataView	dataView()	Returns the value of the dataView record component.
OperationSecurityDescriptors.Eligibility	eligibility()	Returns the value of the eligibility record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
OperationSecurityDescriptors.Family	family()	Returns the value of the family record component.
final int	hashCode()	Returns a hash code value for this object.
boolean	mutating()	Returns the value of the mutating record component.
String	operationId()	Returns the value of the operationId record component.
Permission.ResourceType	resourceType()	Returns the value of the resourceType 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

Constructor Details

Descriptor

public Descriptor(String operationId,
 OperationSecurityDescriptors.Family family,
 Permission.Action action,
 Permission.ResourceType resourceType,
 boolean mutating,
 Permission.DataView dataView,
 OperationSecurityDescriptors.ApprovalCategory approvalCategory,
 OperationSecurityDescriptors.Eligibility eligibility)

Validates one finite descriptor.

Descriptor

public Descriptor(String operationId,
 Permission.Action action,
 Permission.ResourceType resourceType,
 boolean mutating,
 Permission.DataView dataView,
 OperationSecurityDescriptors.ApprovalCategory approvalCategory,
 OperationSecurityDescriptors.Eligibility eligibility)

Creates an existing PKI-family descriptor for embedded callers.

Parameters:

operationId - stable typed-operation identity

action - required permission

resourceType - required resource type

mutating - whether the operation may commit state

dataView - required data view

approvalCategory - approval treatment

eligibility - transport eligibility

Method Details

available

public boolean available()

Returns whether this operation may be advertised for execution. Restore remains registered for authorization and approval of legacy requests, but is unavailable until safe cold activation is supported.

Returns:

whether the operation is available

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

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.

operationId

public String operationId()

Returns the value of the operationId record component.

Returns:

the value of the operationId record component

family

public OperationSecurityDescriptors.Family family()

Returns the value of the family record component.

Returns:

the value of the family record component

action

public Permission.Action action()

Returns the value of the action record component.

Returns:

the value of the action record component

resourceType

public Permission.ResourceType resourceType()

Returns the value of the resourceType record component.

Returns:

the value of the resourceType record component

mutating

public boolean mutating()

Returns the value of the mutating record component.

Returns:

the value of the mutating record component

dataView

public Permission.DataView dataView()

Returns the value of the dataView record component.

Returns:

the value of the dataView record component

approvalCategory

public OperationSecurityDescriptors.ApprovalCategory approvalCategory()

Returns the value of the approvalCategory record component.

Returns:

the value of the approvalCategory record component

eligibility

public OperationSecurityDescriptors.Eligibility eligibility()

Returns the value of the eligibility record component.

Returns:

the value of the eligibility record component