Package org.keycloak.authentication

Interface FormContext

All Known Subinterfaces:
ValidationContext
public interface FormContext
Interface that encapsulates the current state of the current form being executed
Version:
$Revision: 1 $
Author:
Bill Burke

  • Method Summary

    Modifier and Type
    Method
    Description
    org.keycloak.sessions.AuthenticationSessionModel
    getAuthenticationSession()
    AuthenticationSessionModel attached to this flow
    org.keycloak.models.AuthenticatorConfigModel
    getAuthenticatorConfig()
    Get any configuration associated with the current execution
    org.keycloak.common.ClientConnection
    getConnection()
    Information about the IP address from the connecting HTTP client.
    EventBuilder
    getEvent()
    Current event builder being used
    org.keycloak.models.AuthenticationExecutionModel
    getExecution()
    The current execution in the flow
    org.keycloak.http.HttpRequest
    getHttpRequest()
     
    org.keycloak.models.RealmModel
    getRealm()
    Current realm
    org.keycloak.models.KeycloakSession
    getSession()
    Current session
    jakarta.ws.rs.core.UriInfo
    getUriInfo()
    UriInfo of the current request
    org.keycloak.models.UserModel
    getUser()
    Current user attached to this flow.
    EventBuilder
    newEvent()
    Create a refresh new EventBuilder to use within this context
    void
    setUser(org.keycloak.models.UserModel user)
    Attach a specific user to this flow.

  • Method Details

    • getEvent

      EventBuilder getEvent()
      Current event builder being used
      Returns:

    • newEvent

      EventBuilder newEvent()
      Create a refresh new EventBuilder to use within this context
      Returns:

    • getExecution

      org.keycloak.models.AuthenticationExecutionModel getExecution()
      The current execution in the flow
      Returns:

    • getUser

      org.keycloak.models.UserModel getUser()
      Current user attached to this flow. It can return null if no user has been identified yet
      Returns:

    • setUser

      void setUser(org.keycloak.models.UserModel user)
      Attach a specific user to this flow.
      Parameters:
      user -

    • getRealm

      org.keycloak.models.RealmModel getRealm()
      Current realm
      Returns:

    • getAuthenticationSession

      org.keycloak.sessions.AuthenticationSessionModel getAuthenticationSession()
      AuthenticationSessionModel attached to this flow
      Returns:

    • getConnection

      org.keycloak.common.ClientConnection getConnection()
      Information about the IP address from the connecting HTTP client.
      Returns:

    • getUriInfo

      jakarta.ws.rs.core.UriInfo getUriInfo()
      UriInfo of the current request
      Returns:

    • getSession

      org.keycloak.models.KeycloakSession getSession()
      Current session
      Returns:

    • getHttpRequest

      org.keycloak.http.HttpRequest getHttpRequest()

    • getAuthenticatorConfig

      org.keycloak.models.AuthenticatorConfigModel getAuthenticatorConfig()
      Get any configuration associated with the current execution
      Returns: