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 TypeMethodDescriptionAuthenticationSessionModel attached to this flowGet any configuration associated with the current executionInformation about the IP address from the connecting HTTP client.getEvent()
Current event builder being usedThe current execution in the flowgetRealm()
Current realmCurrent sessionjakarta.ws.rs.core.UriInfo
UriInfo of the current requestgetUser()
Current user attached to this flow.newEvent()
Create a refresh new EventBuilder to use within this contextvoid
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
AuthenticationExecutionModel getExecution()The current execution in the flow- Returns:
-
getUser
UserModel getUser()Current user attached to this flow. It can return null if no user has been identified yet- Returns:
-
setUser
Attach a specific user to this flow.- Parameters:
user
-
-
getRealm
RealmModel getRealm()Current realm- Returns:
-
getAuthenticationSession
AuthenticationSessionModel getAuthenticationSession()AuthenticationSessionModel attached to this flow- Returns:
-
getConnection
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
KeycloakSession getSession()Current session- Returns:
-
getHttpRequest
HttpRequest getHttpRequest() -
getAuthenticatorConfig
AuthenticatorConfigModel getAuthenticatorConfig()Get any configuration associated with the current execution- Returns:
-