Package io.fliqa.client.interledger.model

Class InteractRef

java.lang.Object
io.fliqa.client.interledger.model.InteractRef
public class InteractRef extends Object
Represents an interaction reference for the GNAP protocol.

This class contains a reference to a completed user interaction that can be used to continue the grant process. The interaction reference is typically provided by the authorization server after a user has completed the required interaction steps, such as authentication or consent.

The interaction reference serves as a proof that the user interaction has been completed successfully and can be used by the client to continue the access grant process without requiring the user to repeat the interaction.

This is commonly used in scenarios where the client needs to continue a grant request after the user has completed an interaction in a separate context, such as a web browser or mobile app.

Since:
1.0
See Also:

  • Constructor Details

    • InteractRef

      public InteractRef()

  • Method Details

    • build

      public static InteractRef build(String interactRef)
      Creates a new InteractRef instance with the specified interaction reference.

      This factory method provides a convenient way to create an interaction reference object with the specified reference token. The reference token is typically obtained from the authorization server after the user has completed the required interaction.

      Parameters:
      interactRef - the interaction reference token from the authorization server
      Returns:
      a new InteractRef instance with the specified reference
      Throws:
      IllegalArgumentException - if interactRef is null or empty