Package co.ankatech.ankasecure.sdk.model

Record Class KeyFilters

java.lang.Object
java.lang.Record
co.ankatech.ankasecure.sdk.model.KeyFilters
Record Components:
origin - key origin filter (e.g. GENERATED, IMPORTED); null to skip
restricted - restricted-flag filter; null to skip
kty - key type filter (e.g. RSA, ML-KEM, oct, or CompositeMode.KEY_TYPE for every composite key); null to skip
status - lifecycle status filter, as the published token (e.g. active, revoked); deleted_logical selects the tenant's destroyed keys, which no other value (and no null) returns; null to skip
public record KeyFilters(String origin, Boolean restricted, String kty, String status) extends Record
Server-side filters for the key listing endpoints. Filters apply at the server BEFORE pagination, so the page totals returned by listKeys(filters, page, size) are filtered, tenant-scoped counts.

Pass null for any dimension that should not be filtered; use none() for an unfiltered listing. Filters combine with AND logic.

Example


 // All active ML-KEM keys
 KeyFilters filters = new KeyFilters(null, null, "ML-KEM", "active");

 // All imported keys
 KeyFilters imported = new KeyFilters("IMPORTED", null, null, null);

The status filter takes the SAME token a key's status field carries in the response, so a value read back from a listing selects that key when passed straight in here. origin is a separate vocabulary and is genuinely upper-case.

Why kty is a String and not a typed vocabulary

The published contract DOES declare a closed vocabulary: the kty query parameter of GET /api/v3/key-management/keys carries an inline enum of the twenty published key types in AnkaSecureAPI.json. openapi-generator does not lift an INLINE parameter enum into a named type, so the generated KeyQueryApi.listAllKeys takes a String and this record mirrors it. The server is therefore the validator: an unrecognised token is answered with a 400 naming the accepted set, and a composite CONSTRUCTION name is answered with the detail "… is a composite mode, not a key type".

Composite keys are selected with the single coarse CompositeMode.KEY_TYPE token — one value for every pairing and every construction. There is no construction-level filter on this endpoint; the catalogue endpoint is the one that takes a compositeMode filter (see AlgorithmFilter.Builder.withCompositeMode(co.ankatech.ankasecure.sdk.model.CompositeMode...)).

  • Constructor Summary

    Constructors
    Constructor
    Description
    KeyFilters(String origin, Boolean restricted, String kty, String status)
    Refuses the SDK's read-only unknown tokens as filter values.

  • Method Summary

    Modifier and Type
    Method
    Description
    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
    kty()
    Returns the value of the kty record component.
    static KeyFilters
    none()
    An unfiltered listing: every key the tenant still holds, in any lifecycle state (active, expired, suspended, revoked, archived, pending_destruction).
    String
    origin()
    Returns the value of the origin record component.
    Boolean
    restricted()
    Returns the value of the restricted record component.
    String
    status()
    Returns the value of the status record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • KeyFilters

      public KeyFilters(String origin, Boolean restricted, String kty, String status)
      Refuses the SDK's read-only unknown tokens as filter values.

      The comparison trims the value, as the server does before it matches a filter token, and ignores case: no spelling of the unknown token is a published origin or status, so every spelling is refused here instead of reaching the server as a filter.

  • Method Details

    • none

      public static KeyFilters none()
      An unfiltered listing: every key the tenant still holds, in any lifecycle state (active, expired, suspended, revoked, archived, pending_destruction). Destroyed keys are not part of it; they are returned only when the status filter is deleted_logical, as rows that carry the key's identity and destruction date but no algorithm, key type or usage.
      Returns:
      the filter set that narrows nothing

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

    • origin

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

    • restricted

      public Boolean restricted()
      Returns the value of the restricted record component.
      Returns:
      the value of the restricted record component

    • kty

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

    • status

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