Package org.keycloak.forms.login
Interface LoginFormsProvider
-
- All Superinterfaces:
Provider
- All Known Implementing Classes:
FreeMarkerLoginFormsProvider
public interface LoginFormsProvider extends Provider
- Author:
- Stian Thorgersen
-
-
Field Summary
Fields Modifier and Type Field Description static String
IDENTITY_PROVIDER_BROKER_CONTEXT
static String
REGISTRATION_DISABLED
static String
UPDATE_PROFILE_CONTEXT_ATTR
static String
USERNAME_HIDDEN
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description LoginFormsProvider
addError(FormMessage errorMessage)
void
addScript(String scriptUrl)
Adds a script to the html headerLoginFormsProvider
addSuccess(FormMessage errorMessage)
Add a success message to the formjavax.ws.rs.core.Response
createCode()
javax.ws.rs.core.Response
createErrorPage(javax.ws.rs.core.Response.Status status)
javax.ws.rs.core.Response
createForm(String form)
javax.ws.rs.core.Response
createFrontChannelLogoutPage()
javax.ws.rs.core.Response
createIdpLinkConfirmLinkPage()
javax.ws.rs.core.Response
createIdpLinkEmailPage()
javax.ws.rs.core.Response
createInfoPage()
javax.ws.rs.core.Response
createLoginExpiredPage()
javax.ws.rs.core.Response
createLoginPassword()
javax.ws.rs.core.Response
createLoginRecoveryAuthnCode()
javax.ws.rs.core.Response
createLoginTotp()
javax.ws.rs.core.Response
createLoginUsername()
javax.ws.rs.core.Response
createLoginUsernamePassword()
javax.ws.rs.core.Response
createLoginWebAuthn()
javax.ws.rs.core.Response
createLogoutConfirmPage()
javax.ws.rs.core.Response
createOAuth2DeviceVerifyUserCodePage()
javax.ws.rs.core.Response
createOAuthGrant()
javax.ws.rs.core.Response
createPasswordReset()
javax.ws.rs.core.Response
createRegistration()
javax.ws.rs.core.Response
createResponse(UserModel.RequiredAction action)
javax.ws.rs.core.Response
createSamlPostForm()
javax.ws.rs.core.Response
createSelectAuthenticator()
javax.ws.rs.core.Response
createUpdateProfilePage()
javax.ws.rs.core.Response
createWebAuthnErrorPage()
javax.ws.rs.core.Response
createX509ConfirmPage()
String
getMessage(String message)
LoginFormsProvider
setAccessRequest(List<AuthorizationDetails> clientScopesRequested)
LoginFormsProvider
setActionUri(URI requestUri)
LoginFormsProvider
setAttribute(String name, Object value)
LoginFormsProvider
setAuthContext(AuthenticationFlowContext context)
LoginFormsProvider
setAuthenticationSession(AuthenticationSessionModel authenticationSession)
LoginFormsProvider
setClientSessionCode(String accessCode)
LoginFormsProvider
setError(String message, Object... parameters)
Set one global error message.LoginFormsProvider
setErrors(List<FormMessage> messages)
Set multiple error messages.LoginFormsProvider
setExecution(String execution)
LoginFormsProvider
setFormData(javax.ws.rs.core.MultivaluedMap<String,String> formData)
LoginFormsProvider
setInfo(String message, Object... parameters)
LoginFormsProvider
setResponseHeader(String headerName, String headerValue)
LoginFormsProvider
setStatus(javax.ws.rs.core.Response.Status status)
LoginFormsProvider
setSuccess(String message, Object... parameters)
LoginFormsProvider
setUser(UserModel user)
-
-
-
Field Detail
-
UPDATE_PROFILE_CONTEXT_ATTR
static final String UPDATE_PROFILE_CONTEXT_ATTR
- See Also:
- Constant Field Values
-
IDENTITY_PROVIDER_BROKER_CONTEXT
static final String IDENTITY_PROVIDER_BROKER_CONTEXT
- See Also:
- Constant Field Values
-
USERNAME_HIDDEN
static final String USERNAME_HIDDEN
- See Also:
- Constant Field Values
-
REGISTRATION_DISABLED
static final String REGISTRATION_DISABLED
- See Also:
- Constant Field Values
-
-
Method Detail
-
addScript
void addScript(String scriptUrl)
Adds a script to the html header- Parameters:
scriptUrl
-
-
createResponse
javax.ws.rs.core.Response createResponse(UserModel.RequiredAction action)
-
createForm
javax.ws.rs.core.Response createForm(String form)
-
createLoginUsernamePassword
javax.ws.rs.core.Response createLoginUsernamePassword()
-
createLoginUsername
javax.ws.rs.core.Response createLoginUsername()
-
createLoginPassword
javax.ws.rs.core.Response createLoginPassword()
-
createPasswordReset
javax.ws.rs.core.Response createPasswordReset()
-
createLoginTotp
javax.ws.rs.core.Response createLoginTotp()
-
createLoginRecoveryAuthnCode
javax.ws.rs.core.Response createLoginRecoveryAuthnCode()
-
createLoginWebAuthn
javax.ws.rs.core.Response createLoginWebAuthn()
-
createRegistration
javax.ws.rs.core.Response createRegistration()
-
createInfoPage
javax.ws.rs.core.Response createInfoPage()
-
createUpdateProfilePage
javax.ws.rs.core.Response createUpdateProfilePage()
-
createIdpLinkConfirmLinkPage
javax.ws.rs.core.Response createIdpLinkConfirmLinkPage()
-
createIdpLinkEmailPage
javax.ws.rs.core.Response createIdpLinkEmailPage()
-
createLoginExpiredPage
javax.ws.rs.core.Response createLoginExpiredPage()
-
createErrorPage
javax.ws.rs.core.Response createErrorPage(javax.ws.rs.core.Response.Status status)
-
createWebAuthnErrorPage
javax.ws.rs.core.Response createWebAuthnErrorPage()
-
createOAuthGrant
javax.ws.rs.core.Response createOAuthGrant()
-
createSelectAuthenticator
javax.ws.rs.core.Response createSelectAuthenticator()
-
createOAuth2DeviceVerifyUserCodePage
javax.ws.rs.core.Response createOAuth2DeviceVerifyUserCodePage()
-
createCode
javax.ws.rs.core.Response createCode()
-
createX509ConfirmPage
javax.ws.rs.core.Response createX509ConfirmPage()
-
createSamlPostForm
javax.ws.rs.core.Response createSamlPostForm()
-
createFrontChannelLogoutPage
javax.ws.rs.core.Response createFrontChannelLogoutPage()
-
createLogoutConfirmPage
javax.ws.rs.core.Response createLogoutConfirmPage()
-
setAuthenticationSession
LoginFormsProvider setAuthenticationSession(AuthenticationSessionModel authenticationSession)
-
setClientSessionCode
LoginFormsProvider setClientSessionCode(String accessCode)
-
setAccessRequest
LoginFormsProvider setAccessRequest(List<AuthorizationDetails> clientScopesRequested)
-
setError
LoginFormsProvider setError(String message, Object... parameters)
Set one global error message.- Parameters:
message
- key of messageparameters
- to be formatted into message
-
setErrors
LoginFormsProvider setErrors(List<FormMessage> messages)
Set multiple error messages.- Parameters:
messages
- to be set
-
addError
LoginFormsProvider addError(FormMessage errorMessage)
-
addSuccess
LoginFormsProvider addSuccess(FormMessage errorMessage)
Add a success message to the form- Parameters:
errorMessage
-- Returns:
-
setSuccess
LoginFormsProvider setSuccess(String message, Object... parameters)
-
setInfo
LoginFormsProvider setInfo(String message, Object... parameters)
-
setUser
LoginFormsProvider setUser(UserModel user)
-
setResponseHeader
LoginFormsProvider setResponseHeader(String headerName, String headerValue)
-
setFormData
LoginFormsProvider setFormData(javax.ws.rs.core.MultivaluedMap<String,String> formData)
-
setAttribute
LoginFormsProvider setAttribute(String name, Object value)
-
setStatus
LoginFormsProvider setStatus(javax.ws.rs.core.Response.Status status)
-
setActionUri
LoginFormsProvider setActionUri(URI requestUri)
-
setExecution
LoginFormsProvider setExecution(String execution)
-
setAuthContext
LoginFormsProvider setAuthContext(AuthenticationFlowContext context)
-
-