Package io.fliqa.client.interledger.model

Class InterledgerMethod

java.lang.Object

io.fliqa.client.interledger.model.InterledgerMethod

public class InterledgerMethod
extends Object

Represents an Interledger payment method for establishing STREAM connections.

This class defines the ILP (Interledger Protocol) payment method used for making payments through the Interledger network. It contains the necessary information to establish a secure STREAM connection between the sender and receiver for transferring value.

The payment method includes the ILP address for routing payments and a shared secret for encrypting and authenticating the payment stream.

Since:

1.0

See Also:

• STREAM Protocol Specification
• Interledger Open Payments Guide

Field Summary

Fields

Modifier and Type	Field	Description
String	ilpAddress	The ILP address to use when establishing a STREAM connection.
String	sharedSecret	The shared secret used for STREAM connection encryption and authentication.
String	type	The type of payment method.

Constructor Summary

Constructors

Constructor	Description
InterledgerMethod()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

type

public String type

The type of payment method.

For Interledger payments, this is always "ilp" indicating the use of the Interledger Protocol for payment delivery.

See Also:

• Open Payments specification

ilpAddress

public String ilpAddress

The ILP address to use when establishing a STREAM connection.

This is a hierarchical address that follows the ILP address format (e.g., "g.ilp.example.alice"). The address is used to route payments through the Interledger network to the intended recipient.

Valid ILP addresses must:

• Start with a scheme: g, private, example, peer, self, test[1-3], or local
• Be followed by segments separated by dots
• Contain only alphanumeric characters, underscores, tildes, and hyphens
• Be at most 1023 characters long

See Also:

• ILP Address Format

sharedSecret

public String sharedSecret

The shared secret used for STREAM connection encryption and authentication.

This is a base64url-encoded secret that is shared between the sender and receiver to establish a secure STREAM connection. The shared secret is used to encrypt packet contents and authenticate the connection.

The shared secret is typically 32 bytes (256 bits) of cryptographically secure random data, encoded as a base64url string without padding.

See Also:

• STREAM Protocol Security

Constructor Details

InterledgerMethod

public InterledgerMethod()