Package io.fliqa.client.interledger.model

Class AccessInteract

java.lang.Object
io.fliqa.client.interledger.model.AccessInteract
public class AccessInteract extends Object
Represents the interaction requirements for a GNAP access request.

This class defines how a client can interact with the authorization server to obtain consent from the resource owner. It specifies the interaction methods that the client supports and how the authorization server should communicate the results back to the client.

The interaction flow in GNAP typically involves:

  1. The client specifies supported interaction methods (start)
  2. The authorization server chooses one and initiates user interaction
  3. The user completes the interaction (consent, authentication, etc.)
  4. The authorization server communicates the result back (finish)
Since:
1.0
See Also:

  • Field Details

    • start

      public List<String> start
      The interaction methods that the client supports.

      This list contains the interaction methods that the client is capable of handling. Common interaction methods include:

      • "redirect" - Browser-based redirect interaction
      • "app" - Application-based interaction
      • "device" - Device flow interaction
      • "user_code" - User code-based interaction

      The authorization server will choose one of these methods to initiate the interaction with the resource owner.

      Example: ["redirect", "app"]

    • finish

      public InteractFinish finish
      Optional specification for how the authorization server should communicate the interaction result back to the client.

      This field defines the mechanism that the authorization server should use to notify the client when the interaction is complete. If not specified, the client may need to poll the authorization server or use other means to determine when the interaction is finished.

      See Also:

  • Constructor Details

    • AccessInteract

      public AccessInteract()