Package io.fliqa.client.interledger.model

Class InteractFinish

java.lang.Object
io.fliqa.client.interledger.model.InteractFinish
public class InteractFinish extends Object
Represents the finish specification for interactions in the GNAP protocol.

This class defines how the authorization server should communicate the completion of a user interaction back to the client. It specifies the method to use for notification, the URI where the client should be contacted or redirected, and a nonce for security purposes.

The interact finish mechanism is used to ensure that the client can reliably receive notification when the user has completed the required interaction with the authorization server. This is crucial for continuing the grant process after user consent or authentication.

Common finish methods include:

  • "redirect" - Browser redirect to the client's callback URI
  • "push" - Server-to-server notification to the client
Since:
1.0
See Also:

  • Field Details

    • method

      public String method
      The method to use for notifying the client of interaction completion.

      This field specifies how the authorization server should communicate the completion of the user interaction back to the client. The method determines the mechanism used for the notification.

      Supported methods:

      • "redirect" - Browser redirect to the client's callback URI
      • "push" - Direct server-to-server notification

      Example: "redirect"

    • uri

      public URI uri
      The URI where the client should be contacted or redirected after interaction.

      This URI serves as the callback endpoint where the authorization server will send the interaction completion notification. For redirect methods, this is where the user's browser will be redirected. For push methods, this is the endpoint that will receive the server-to-server notification.

      The authorization server may append additional parameters to this URI to communicate the result of the interaction.

      Example: "https://client.example.com/callback"

    • nonce

      public String nonce
      A unique value to prevent replay attacks during the interaction.

      This nonce is used to ensure the security and integrity of the interaction finish process. It helps prevent replay attacks and ensures that the interaction completion notification is authentic and recent.

      The nonce should be a cryptographically random value that is unique for each interaction. The client should verify this nonce when receiving the interaction completion notification.

      Example: "VjVHaYojGUc3dJd4oQ8WwHm5YGxmE3"

  • Constructor Details

    • InteractFinish

      public InteractFinish()