Package io.fliqa.client.interledger.model

Enum Class AccessAction

java.lang.Object
java.lang.Enum<AccessAction>
io.fliqa.client.interledger.model.AccessAction
All Implemented Interfaces:
Serializable, Comparable<AccessAction>, Constable
public enum AccessAction extends Enum<AccessAction>
Enumeration of access actions available for Interledger Open Payments operations.

This enum defines the specific actions that can be requested in an access grant for different types of payment resources. Access actions control what operations a client can perform on payment resources like incoming payments, outgoing payments, and quotes.

Actions are combined with resource types to create fine-grained access control for payment operations, ensuring that clients only have the minimum necessary permissions to perform their intended functions.

Since:
1.0
See Also:

  • Enum Constant Details

    • read

      public static final AccessAction read
      Permission to read a specific resource.

      Allows the client to retrieve information about a specific payment resource identified by its URI. This is used for reading individual payments, quotes, or other resources.

    • complete

      public static final AccessAction complete
      Permission to complete a resource operation.

      Allows the client to finalize or complete a payment operation that was previously initiated. This is commonly used for completing outgoing payments after user authorization.

    • create

      public static final AccessAction create
      Permission to create a new resource.

      Allows the client to create new payment resources such as incoming payments, outgoing payments, or quotes. This is typically the first step in payment operations.

    • read_all

      public static final AccessAction read_all
      Permission to read all resources of a specific type.

      Allows the client to access all resources of a given type within the wallet address scope, not just specific resources. This is broader than the read action.

    • list

      public static final AccessAction list
      Permission to list resources.

      Allows the client to retrieve a list of resources of a specific type. This is typically used for getting paginated lists of payments or quotes.

    • list_all

      public static final AccessAction list_all
      Permission to list all resources of a specific type.

      Allows the client to retrieve comprehensive lists of all resources of a specific type within the wallet address scope. This is broader than the list action.

  • Field Details

    • value

      public final String value
      The string value used in JSON serialization.

  • Method Details

    • values

      public static AccessAction[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static AccessAction valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • toString

      public String toString()
      Overrides:
      toString in class Enum<AccessAction>

    • getValue

      public String getValue()
      Gets the JSON string value for this access action.
      Returns:
      the string value used in JSON serialization

    • fromValue

      public static AccessAction fromValue(String value)
      Creates an AccessAction from its string value.
      Parameters:
      value - the string value to convert
      Returns:
      the corresponding AccessAction enum value
      Throws:
      IllegalArgumentException - if the value doesn't match any known action