Package co.ankatech.ankasecure.keymanagement.query

Record Class CapabilityGrantListQuery

java.lang.Object
java.lang.Record
co.ankatech.ankasecure.keymanagement.query.CapabilityGrantListQuery
Record Components:
actorId - the grantee actor; null for every actor
assetKid - the key the grant covers; null for every key
exchangeContextId - the exchange context the grant is bound to; null for every context
constraintPolicyId - the constraint policy the grant carries; null for every policy
page - the zero-based page number; null for the server default (0)
size - the page size; null for the server default (25)
sort - sort criteria as property,ASC|DESC; null for the server default (createdAt,DESC)
public record CapabilityGrantListQuery(UUID actorId, String assetKid, UUID exchangeContextId, UUID constraintPolicyId, Integer page, Integer size, List<String> sort) extends Record
The filters and page of a capability grant listing (capabilityGrants().list).

Its components are exactly the query parameters of the listCapabilityGrants operation; a null component sends nothing, so the server applies its default.


 CapabilityGrantListQuery.firstPage().withAssetKid("payments-signing-key")

  • Constructor Details

    • CapabilityGrantListQuery

      public CapabilityGrantListQuery(UUID actorId, String assetKid, UUID exchangeContextId, UUID constraintPolicyId, Integer page, Integer size, List<String> sort)
      Canonical constructor; copies every list component.

  • Method Details

    • firstPage

      public static CapabilityGrantListQuery firstPage()
      Returns:
      the first page with the server's defaults and no filter

    • withActorId

      public CapabilityGrantListQuery withActorId(UUID value)
      Parameters:
      value - the new actorId; null clears it
      Returns:
      a copy of this query with actorId replaced

    • withAssetKid

      public CapabilityGrantListQuery withAssetKid(String value)
      Parameters:
      value - the new assetKid; null clears it
      Returns:
      a copy of this query with assetKid replaced

    • withExchangeContextId

      public CapabilityGrantListQuery withExchangeContextId(UUID value)
      Parameters:
      value - the new exchangeContextId; null clears it
      Returns:
      a copy of this query with exchangeContextId replaced

    • withConstraintPolicyId

      public CapabilityGrantListQuery withConstraintPolicyId(UUID value)
      Parameters:
      value - the new constraintPolicyId; null clears it
      Returns:
      a copy of this query with constraintPolicyId replaced

    • withPage

      public CapabilityGrantListQuery withPage(Integer value)
      Parameters:
      value - the new page; null clears it
      Returns:
      a copy of this query with page replaced

    • withSize

      public CapabilityGrantListQuery withSize(Integer value)
      Parameters:
      value - the new size; null clears it
      Returns:
      a copy of this query with size replaced

    • withSort

      public CapabilityGrantListQuery withSort(List<String> value)
      Parameters:
      value - the new sort; null clears it
      Returns:
      a copy of this query with sort replaced

    • 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.

    • actorId

      public UUID actorId()
      Returns the value of the actorId record component.
      Returns:
      the value of the actorId record component

    • assetKid

      public String assetKid()
      Returns the value of the assetKid record component.
      Returns:
      the value of the assetKid record component

    • exchangeContextId

      public UUID exchangeContextId()
      Returns the value of the exchangeContextId record component.
      Returns:
      the value of the exchangeContextId record component

    • constraintPolicyId

      public UUID constraintPolicyId()
      Returns the value of the constraintPolicyId record component.
      Returns:
      the value of the constraintPolicyId record component

    • page

      public Integer page()
      Returns the value of the page record component.
      Returns:
      the value of the page record component

    • size

      public Integer size()
      Returns the value of the size record component.
      Returns:
      the value of the size record component

    • sort

      public List<String> sort()
      Returns the value of the sort record component.
      Returns:
      the value of the sort record component