public class RequiredActionContextResult extends Object implements RequiredActionContext
RequiredActionContext.Status| Modifier and Type | Field and Description |
|---|---|
protected javax.ws.rs.core.Response |
challenge |
protected ClientSessionModel |
clientSession |
protected EventBuilder |
eventBuilder |
protected RequiredActionFactory |
factory |
protected org.jboss.resteasy.spi.HttpRequest |
httpRequest |
protected RealmModel |
realm |
protected KeycloakSession |
session |
protected RequiredActionContext.Status |
status |
protected UserModel |
user |
protected UserSessionModel |
userSession |
| Constructor and Description |
|---|
RequiredActionContextResult(UserSessionModel userSession,
ClientSessionModel clientSession,
RealmModel realm,
EventBuilder eventBuilder,
KeycloakSession session,
org.jboss.resteasy.spi.HttpRequest httpRequest,
UserModel user,
RequiredActionFactory factory) |
| Modifier and Type | Method and Description |
|---|---|
void |
challenge(javax.ws.rs.core.Response response)
Send a challenge Response back to user
|
void |
failure()
Abort the authentication with an error
|
LoginFormsProvider |
form()
Create a Freemarker form builder that presets the user, action URI, and a generated access code
|
String |
generateCode()
Generates access code and updates clientsession timestamp
Access codes must be included in form action callbacks as a query parameter.
|
URI |
getActionUrl()
Get the action URL for the required action.
|
URI |
getActionUrl(String code)
Get the action URL for the required action.
|
javax.ws.rs.core.Response |
getChallenge()
If challenge has been sent this returns the JAX-RS Response
|
ClientSessionModel |
getClientSession() |
ClientConnection |
getConnection() |
EventBuilder |
getEvent()
Current event builder being used
|
org.jboss.resteasy.spi.HttpRequest |
getHttpRequest() |
RealmModel |
getRealm() |
KeycloakSession |
getSession() |
RequiredActionContext.Status |
getStatus() |
javax.ws.rs.core.UriInfo |
getUriInfo() |
UserModel |
getUser()
Current user
|
UserSessionModel |
getUserSession() |
void |
ignore()
Ignore this required action and go onto the next, or complete the flow.
|
void |
success()
Mark this required action as successful.
|
protected UserSessionModel userSession
protected ClientSessionModel clientSession
protected RealmModel realm
protected EventBuilder eventBuilder
protected KeycloakSession session
protected RequiredActionContext.Status status
protected javax.ws.rs.core.Response challenge
protected org.jboss.resteasy.spi.HttpRequest httpRequest
protected UserModel user
protected RequiredActionFactory factory
public RequiredActionContextResult(UserSessionModel userSession, ClientSessionModel clientSession, RealmModel realm, EventBuilder eventBuilder, KeycloakSession session, org.jboss.resteasy.spi.HttpRequest httpRequest, UserModel user, RequiredActionFactory factory)
public EventBuilder getEvent()
RequiredActionContextgetEvent in interface RequiredActionContextpublic UserModel getUser()
RequiredActionContextgetUser in interface RequiredActionContextpublic RealmModel getRealm()
getRealm in interface RequiredActionContextpublic ClientSessionModel getClientSession()
getClientSession in interface RequiredActionContextpublic UserSessionModel getUserSession()
getUserSession in interface RequiredActionContextpublic ClientConnection getConnection()
getConnection in interface RequiredActionContextpublic javax.ws.rs.core.UriInfo getUriInfo()
getUriInfo in interface RequiredActionContextpublic KeycloakSession getSession()
getSession in interface RequiredActionContextpublic org.jboss.resteasy.spi.HttpRequest getHttpRequest()
getHttpRequest in interface RequiredActionContextpublic RequiredActionContext.Status getStatus()
getStatus in interface RequiredActionContextpublic void challenge(javax.ws.rs.core.Response response)
RequiredActionContextchallenge in interface RequiredActionContextpublic void failure()
RequiredActionContextfailure in interface RequiredActionContextpublic void success()
RequiredActionContextsuccess in interface RequiredActionContextpublic void ignore()
RequiredActionContextignore in interface RequiredActionContextpublic URI getActionUrl(String code)
RequiredActionContextgetActionUrl in interface RequiredActionContextcode - client sessino access codepublic String generateCode()
RequiredActionContextgenerateCode in interface RequiredActionContextpublic URI getActionUrl()
RequiredActionContextgetActionUrl in interface RequiredActionContextpublic LoginFormsProvider form()
RequiredActionContextform in interface RequiredActionContextpublic javax.ws.rs.core.Response getChallenge()
RequiredActionContextgetChallenge in interface RequiredActionContextCopyright © 2016 JBoss by Red Hat. All rights reserved.