public interface AuthenticationFlowContext extends AbstractAuthenticationFlowContext
Modifier and Type | Method and Description |
---|---|
void |
attachUserSession(UserSessionModel userSession) |
void |
cancelLogin()
End the flow and redirect browser based on protocol specific respones.
|
void |
clearUser()
Clear the user from the flow.
|
void |
fork()
Fork the current flow.
|
void |
forkWithErrorMessage(FormMessage message)
Fork the current flow.
|
void |
forkWithSuccessMessage(FormMessage message)
Fork the current flow.
|
LoginFormsProvider |
form()
Create a Freemarker form builder that presets the user, action URI, and a generated access code
|
URI |
getActionTokenUrl(String tokenString)
Get the action URL for the action token executor.
|
URI |
getActionUrl(String code)
Get the action URL for the required action.
|
URI |
getActionUrl(String code,
boolean authSessionIdParam)
Get the action URL for the required action.
|
List<AuthenticationSelectionOption> |
getAuthenticationSelections() |
AuthenticationSessionModel |
getAuthenticationSession()
AuthenticationSessionModel attached to this flow
|
String |
getFlowPath() |
URI |
getRefreshExecutionUrl()
Get the refresh URL for the required action.
|
URI |
getRefreshUrl(boolean authSessionIdParam)
Get the refresh URL for the flow.
|
UserModel |
getUser()
Current user attached to this flow.
|
void |
resetFlow()
Reset the current flow to the beginning and restarts it.
|
void |
resetFlow(Runnable afterResetListener)
Reset the current flow to the beginning and restarts it.
|
void |
setAuthenticationSelections(List<AuthenticationSelectionOption> credentialAuthExecMap) |
void |
setUser(UserModel user)
Attach a specific user to this flow.
|
attempted, challenge, failure, failure, failureChallenge, forceChallenge, generateAccessCode, getAuthenticatorConfig, getCategoryRequirementFromCurrentFlow, getConnection, getError, getEvent, getExecution, getForwardedErrorMessage, getForwardedSuccessMessage, getHttpRequest, getProtector, getRealm, getSession, getStatus, getUriInfo, newEvent, success
UserModel getUser()
void setUser(UserModel user)
user
- List<AuthenticationSelectionOption> getAuthenticationSelections()
void setAuthenticationSelections(List<AuthenticationSelectionOption> credentialAuthExecMap)
void clearUser()
void attachUserSession(UserSessionModel userSession)
AuthenticationSessionModel getAuthenticationSession()
String getFlowPath()
LoginFormsProvider form()
URI getActionUrl(String code)
code
- authentication session access codeURI getActionUrl(String code, boolean authSessionIdParam)
code
- authentication session access codeauthSessionIdParam
- will include auth_session query param for clients that don't process cookiesURI getActionTokenUrl(String tokenString)
tokenString
- String representation (JWT) of action tokenURI getRefreshExecutionUrl()
URI getRefreshUrl(boolean authSessionIdParam)
authSessionIdParam
- will include auth_session query param for clients that don't process cookiesvoid cancelLogin()
void resetFlow()
void resetFlow(Runnable afterResetListener)
void fork()
void forkWithSuccessMessage(FormMessage message)
message
- Corresponds to raw text or a message property defined in a message bundlevoid forkWithErrorMessage(FormMessage message)
message
- Corresponds to raw text or a message property defined in a message bundleCopyright © 2021 JBoss by Red Hat. All rights reserved.