Package io.fliqa.client.interledger.model

Enum Class AccessItemType

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

This enum defines the different types of payment resources that can be accessed through the Interledger Open Payments protocol. Each resource type represents a different aspect of the payment flow and can be combined with AccessAction to create specific access permissions.

Resource types are used in access grants to specify which types of operations a client is authorized to perform within a wallet address scope.

Since:
1.0
See Also:

  • Enum Constant Details

    • incomingPayment

      public static final AccessItemType incomingPayment
      Incoming payment resource type.

      Represents access to incoming payment resources, which are used to receive payments from other parties. Incoming payments define the destination for value transfer and include payment pointers, amounts, and payment methods.

      Common operations include creating incoming payments to receive funds and reading incoming payment details to track received amounts.

    • outgoingPayment

      public static final AccessItemType outgoingPayment
      Outgoing payment resource type.

      Represents access to outgoing payment resources, which are used to send payments to other parties. Outgoing payments define the source and destination for value transfer and require user authorization.

      Common operations include creating outgoing payments to send funds, completing authorized payments, and reading payment status.

    • quote

      public static final AccessItemType quote
      Quote resource type.

      Represents access to quote resources, which provide cost estimates for payment operations. Quotes calculate fees, exchange rates, and final amounts before executing actual payments.

      Common operations include creating quotes to estimate payment costs and reading quote details to understand payment economics.

  • Field Details

    • value

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

  • Method Details

    • values

      public static AccessItemType[] 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 AccessItemType 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<AccessItemType>

    • getValue

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

    • fromValue

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