Package co.ankatech.keymanagement.client.keymanagement.model

Class ExchangeGrantRequest

java.lang.Object
co.ankatech.keymanagement.client.keymanagement.model.ExchangeGrantRequest
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class ExchangeGrantRequest extends Object
A Capability Grant to add to a Cryptographic Exchange. The Exchange owns the grant, and the grant authorizes in the Exchange's Exchange Context.

  • Field Details

  • Constructor Details

    • ExchangeGrantRequest

      public ExchangeGrantRequest()

  • Method Details

    • actorId

      public ExchangeGrantRequest actorId(@Nonnull UUID actorId)

    • getActorId

      @Nonnull public UUID getActorId()
      The Cryptographic Actor the grant authorizes. It belongs to an application that is an endpoint of the Exchange.
      Returns:
      actorId

    • setActorId

      public void setActorId(@Nonnull UUID actorId)

    • assetKids

      public ExchangeGrantRequest assetKids(@Nullable List<String> assetKids)

    • addAssetKidsItem

      public ExchangeGrantRequest addAssetKidsItem(String assetKidsItem)

    • getAssetKids

      @Nullable public List<String> getAssetKids()
      The one Key ID a basic grant authorizes. Absent or empty for a REENCRYPT or RESIGN grant, whose keys are its keyPairs.
      Returns:
      assetKids

    • setAssetKids

      public void setAssetKids(@Nullable List<String> assetKids)

    • capabilities

      public ExchangeGrantRequest capabilities(@Nonnull List<String> capabilities)

    • addCapabilitiesItem

      public ExchangeGrantRequest addCapabilitiesItem(String capabilitiesItem)

    • getCapabilities

      @Nonnull public List<String> getCapabilities()
      Capabilities of the grant: one to four of ENCRYPT, DECRYPT, SIGN, VERIFY, or exactly one of REENCRYPT, RESIGN alone. REENCRYPT never implies DECRYPT.
      Returns:
      capabilities

    • setCapabilities

      public void setCapabilities(@Nonnull List<String> capabilities)

    • constraintPolicyId

      public ExchangeGrantRequest constraintPolicyId(@Nullable UUID constraintPolicyId)

    • getConstraintPolicyId

      @Nullable public UUID getConstraintPolicyId()
      Optional Constraint Policy of the tenant; the grant enforces its current version
      Returns:
      constraintPolicyId

    • setConstraintPolicyId

      public void setConstraintPolicyId(@Nullable UUID constraintPolicyId)

    • keyPairs

      public ExchangeGrantRequest keyPairs(@Nullable List<CapabilityGrantKeyPair> keyPairs)

    • addKeyPairsItem

      public ExchangeGrantRequest addKeyPairsItem(CapabilityGrantKeyPair keyPairsItem)

    • getKeyPairs

      @Nullable public List<CapabilityGrantKeyPair> getKeyPairs()
      The ordered key pairs a REENCRYPT or RESIGN grant authorizes, one or more (at most 32); each authorizes the transformation from its sourceKid to its targetKid only. Absent or empty for a basic grant.
      Returns:
      keyPairs

    • setKeyPairs

      public void setKeyPairs(@Nullable List<CapabilityGrantKeyPair> keyPairs)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • validateJsonElement

      public static void validateJsonElement(com.google.gson.JsonElement jsonElement) throws IOException
      Validates the JSON Element and throws an exception if issues found
      Parameters:
      jsonElement - JSON Element
      Throws:
      IOException - if the JSON Element is invalid with respect to ExchangeGrantRequest

    • validateJsonElementAsCandidate

      public static void validateJsonElementAsCandidate(com.google.gson.JsonElement jsonElement) throws IOException
      Validates the JSON Element as a candidate of a oneOf schema: the checks of validateJsonElement(JsonElement), and the element carries no member this model does not declare. A oneOf schema without a discriminator tells its candidates apart by their member sets, so a candidate is matched on its closed member set.
      Parameters:
      jsonElement - JSON Element
      Throws:
      IOException - if the JSON Element is not a ExchangeGrantRequest

    • fromJson

      public static ExchangeGrantRequest fromJson(String jsonString) throws IOException
      Create an instance of ExchangeGrantRequest given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of ExchangeGrantRequest
      Throws:
      IOException - if the JSON string is invalid with respect to ExchangeGrantRequest

    • toJson

      public String toJson()
      Convert an instance of ExchangeGrantRequest to an JSON string
      Returns:
      JSON string