org.keycloak.login.freemarker

Class FreeMarkerLoginFormsProvider

java.lang.Object

org.keycloak.login.freemarker.FreeMarkerLoginFormsProvider

All Implemented Interfaces:

LoginFormsProvider, Provider

public class FreeMarkerLoginFormsProvider
extends Object
implements LoginFormsProvider

Author:

Stian Thorgersen

Constructor Summary

Constructors

Constructor and Description
FreeMarkerLoginFormsProvider(KeycloakSession session, FreeMarkerUtil freeMarker)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
javax.ws.rs.core.Response	createCode()
javax.ws.rs.core.Response	createErrorPage()
javax.ws.rs.core.Response	createInfoPage()
javax.ws.rs.core.Response	createLogin()
javax.ws.rs.core.Response	createLoginTotp()
javax.ws.rs.core.Response	createOAuthGrant(ClientSessionModel clientSession)
javax.ws.rs.core.Response	createPasswordReset()
javax.ws.rs.core.Response	createRegistration()
javax.ws.rs.core.Response	createResponse(UserModel.RequiredAction action)
protected String	formatMessage(FormMessage message, Properties messagesBundle, Locale locale)
protected String	getFirstMessageUnformatted()
LoginFormsProvider	setAccessRequest(List<RoleModel> realmRolesRequested, javax.ws.rs.core.MultivaluedMap<String,RoleModel> resourceRolesRequested)
LoginFormsProvider	setAccessRequest(String accessRequestMessage)
LoginFormsProvider	setActionUri(URI actionUri)
FreeMarkerLoginFormsProvider	setClient(ClientModel client)
LoginFormsProvider	setClientSessionCode(String accessCode)
FreeMarkerLoginFormsProvider	setError(String message, Object... parameters) Set one global error message.
LoginFormsProvider	setErrors(List<FormMessage> messages) Set multiple error messages.
FreeMarkerLoginFormsProvider	setFormData(javax.ws.rs.core.MultivaluedMap<String,String> formData)
LoginFormsProvider	setHttpHeaders(javax.ws.rs.core.HttpHeaders httpHeaders)
protected void	setMessage(MessageType type, String message, Object... parameters)
LoginFormsProvider	setQueryParams(javax.ws.rs.core.MultivaluedMap<String,String> queryParams)
LoginFormsProvider	setRealm(RealmModel realm)
LoginFormsProvider	setResponseHeader(String headerName, String headerValue)
LoginFormsProvider	setStatus(javax.ws.rs.core.Response.Status status)
FreeMarkerLoginFormsProvider	setSuccess(String message, Object... parameters)
LoginFormsProvider	setUriInfo(javax.ws.rs.core.UriInfo uriInfo)
FreeMarkerLoginFormsProvider	setUser(UserModel user)
FreeMarkerLoginFormsProvider	setWarning(String message, Object... parameters)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FreeMarkerLoginFormsProvider

public FreeMarkerLoginFormsProvider(KeycloakSession session,
                            FreeMarkerUtil freeMarker)

Method Detail

setRealm

public LoginFormsProvider setRealm(RealmModel realm)

Specified by:

setRealm in interface LoginFormsProvider

setUriInfo

public LoginFormsProvider setUriInfo(javax.ws.rs.core.UriInfo uriInfo)

Specified by:

setUriInfo in interface LoginFormsProvider

setHttpHeaders

public LoginFormsProvider setHttpHeaders(javax.ws.rs.core.HttpHeaders httpHeaders)

Specified by:

setHttpHeaders in interface LoginFormsProvider

createResponse

public javax.ws.rs.core.Response createResponse(UserModel.RequiredAction action)

Specified by:

createResponse in interface LoginFormsProvider

createLogin

public javax.ws.rs.core.Response createLogin()

Specified by:

createLogin in interface LoginFormsProvider

createPasswordReset

public javax.ws.rs.core.Response createPasswordReset()

Specified by:

createPasswordReset in interface LoginFormsProvider

createLoginTotp

public javax.ws.rs.core.Response createLoginTotp()

Specified by:

createLoginTotp in interface LoginFormsProvider

createRegistration

public javax.ws.rs.core.Response createRegistration()

Specified by:

createRegistration in interface LoginFormsProvider

createInfoPage

public javax.ws.rs.core.Response createInfoPage()

Specified by:

createInfoPage in interface LoginFormsProvider

createErrorPage

public javax.ws.rs.core.Response createErrorPage()

Specified by:

createErrorPage in interface LoginFormsProvider

createOAuthGrant

public javax.ws.rs.core.Response createOAuthGrant(ClientSessionModel clientSession)

Specified by:

createOAuthGrant in interface LoginFormsProvider

createCode

public javax.ws.rs.core.Response createCode()

Specified by:

createCode in interface LoginFormsProvider

setMessage

protected void setMessage(MessageType type,
              String message,
              Object... parameters)

getFirstMessageUnformatted

protected String getFirstMessageUnformatted()

formatMessage

protected String formatMessage(FormMessage message,
                   Properties messagesBundle,
                   Locale locale)

setError

public FreeMarkerLoginFormsProvider setError(String message,
                                    Object... parameters)

Description copied from interface: LoginFormsProvider

Set one global error message.

Specified by:

setError in interface LoginFormsProvider

Parameters:

message - key of message

parameters - to be formatted into message

setErrors

public LoginFormsProvider setErrors(List<FormMessage> messages)

Description copied from interface: LoginFormsProvider

Set multiple error messages.

Specified by:

setErrors in interface LoginFormsProvider

Parameters:

messages - to be set

setSuccess

public FreeMarkerLoginFormsProvider setSuccess(String message,
                                      Object... parameters)

Specified by:

setSuccess in interface LoginFormsProvider

setWarning

public FreeMarkerLoginFormsProvider setWarning(String message,
                                      Object... parameters)

Specified by:

setWarning in interface LoginFormsProvider

setUser

public FreeMarkerLoginFormsProvider setUser(UserModel user)

Specified by:

setUser in interface LoginFormsProvider

setClient

public FreeMarkerLoginFormsProvider setClient(ClientModel client)

Specified by:

setClient in interface LoginFormsProvider

setFormData

public FreeMarkerLoginFormsProvider setFormData(javax.ws.rs.core.MultivaluedMap<String,String> formData)

Specified by:

setFormData in interface LoginFormsProvider

setClientSessionCode

public LoginFormsProvider setClientSessionCode(String accessCode)

Specified by:

setClientSessionCode in interface LoginFormsProvider

setAccessRequest

public LoginFormsProvider setAccessRequest(List<RoleModel> realmRolesRequested,
                                  javax.ws.rs.core.MultivaluedMap<String,RoleModel> resourceRolesRequested)

Specified by:

setAccessRequest in interface LoginFormsProvider

setAccessRequest

public LoginFormsProvider setAccessRequest(String accessRequestMessage)

Specified by:

setAccessRequest in interface LoginFormsProvider

setStatus

public LoginFormsProvider setStatus(javax.ws.rs.core.Response.Status status)

Specified by:

setStatus in interface LoginFormsProvider

setQueryParams

public LoginFormsProvider setQueryParams(javax.ws.rs.core.MultivaluedMap<String,String> queryParams)

Specified by:

setQueryParams in interface LoginFormsProvider

setActionUri

public LoginFormsProvider setActionUri(URI actionUri)

Specified by:

setActionUri in interface LoginFormsProvider

setResponseHeader

public LoginFormsProvider setResponseHeader(String headerName,
                                   String headerValue)

Specified by:

setResponseHeader in interface LoginFormsProvider

close

public void close()

Specified by:

close in interface Provider