Package org.forgerock.openam.auth.node.api

Interface SuspensionHandler

Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface @EvolvingAll public interface SuspensionHandler
This handler interface allows authentication nodes to suspend authentication and send a unique ID out of band to the end-user. Once the user provides this token ID to the authentication framework, the authentication process will be resumed and the currently executing node will be able to continue processing the authentication request.

  • Method Summary

    Modifier and Type
    Method
    Description
    Callback
    handle(URI resumeURI)
    Handles a suspension request by sending the suspension ID out of band to the end-user to allow them to continue the authentication flow.

  • Method Details

    • handle

      Callback handle(URI resumeURI) throws NodeProcessException
      Handles a suspension request by sending the suspension ID out of band to the end-user to allow them to continue the authentication flow.
      Parameters:
      resumeURI - the URI that will be used to resume authentication.
      Returns:
      The Callback describes the outcome having enacted the out of bounds action.
      Throws:
      NodeProcessException - If there was an unrecoverable error occurring while sending the suspension ID to the end-user. This will result in a failed authentication from the user's perspective.