org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider クラス

org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider の継承関係図

org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider 連携図

公開メンバ関数
	FreeMarkerLoginFormsProvider (KeycloakSession session, FreeMarkerUtil freeMarker)
void	addScript (String scriptUrl)
Response	createResponse (UserModel.RequiredAction action)
Response	createForm (String form)
String	getMessage (String message)
String	getMessage (String message, String... parameters)
Response	createLogin ()
Response	createPasswordReset ()
Response	createLoginTotp ()
Response	createRegistration ()
Response	createInfoPage ()
Response	createUpdateProfilePage ()
Response	createIdpLinkConfirmLinkPage ()
Response	createLoginExpiredPage ()
Response	createIdpLinkEmailPage ()
Response	createErrorPage (Response.Status status)
Response	createOAuthGrant ()
Response	createCode ()
Response	createX509ConfirmPage ()
FreeMarkerLoginFormsProvider	setError (String message, Object... parameters)
LoginFormsProvider	setErrors (List< FormMessage > messages)
LoginFormsProvider	addError (FormMessage errorMessage)
LoginFormsProvider	addSuccess (FormMessage errorMessage)
FreeMarkerLoginFormsProvider	setSuccess (String message, Object... parameters)
FreeMarkerLoginFormsProvider	setInfo (String message, Object... parameters)
LoginFormsProvider	setAuthenticationSession (AuthenticationSessionModel authenticationSession)
FreeMarkerLoginFormsProvider	setUser (UserModel user)
FreeMarkerLoginFormsProvider	setFormData (MultivaluedMap< String, String > formData)
LoginFormsProvider	setClientSessionCode (String accessCode)
LoginFormsProvider	setAccessRequest (List< ClientScopeModel > clientScopesRequested)
LoginFormsProvider	setAttribute (String name, Object value)
LoginFormsProvider	setStatus (Response.Status status)
LoginFormsProvider	setMediaType (javax.ws.rs.core.MediaType type)
LoginFormsProvider	setActionUri (URI actionUri)
LoginFormsProvider	setExecution (String execution)
LoginFormsProvider	setResponseHeader (String headerName, String headerValue)
void	close ()

限定公開メンバ関数
Response	createResponse (LoginFormsPages page)
UriBuilder	prepareBaseUriBuilder (boolean resetRequestUriParams)
Theme	getTheme () throws IOException
Properties	handleThemeResources (Theme theme, Locale locale)
void	handleMessages (Locale locale, Properties messagesBundle)
void	createCommonAttributes (Theme theme, Locale locale, Properties messagesBundle, UriBuilder baseUriBuilder, LoginFormsPages page)
Response	processTemplate (Theme theme, String templateName, Locale locale)
void	setMessage (MessageType type, String message, Object... parameters)
String	getFirstMessageUnformatted ()
String	formatMessage (FormMessage message, Properties messagesBundle, Locale locale)

限定公開変数類
String	accessCode
Response.Status	status
javax.ws.rs.core.MediaType	contentType
List< ClientScopeModel >	clientScopesRequested
Map< String, String >	httpResponseHeaders = new HashMap<>()
URI	actionUri
String	execution
List< FormMessage >	messages = null
MessageType	messageType = MessageType.ERROR
MultivaluedMap< String, String >	formData
KeycloakSession	session
AuthenticationSessionModel	authenticationSession
RealmModel	realm
ClientModel	client
UriInfo	uriInfo
FreeMarkerUtil	freeMarker
UserModel	user
final Map< String, Object >	attributes = new HashMap<>()

静的非公開変数類
static final Logger	logger = Logger.getLogger(FreeMarkerLoginFormsProvider.class)

詳解

著者

Stian Thorgersen

構築子と解体子

FreeMarkerLoginFormsProvider()

org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.FreeMarkerLoginFormsProvider ( KeycloakSession  session, FreeMarkerUtil  freeMarker  )

inline

                                                                                            {
        this.session = session;
        this.freeMarker = freeMarker;
        this.attributes.put("scripts", new LinkedList<>());
        this.realm = session.getContext().getRealm();
        this.client = session.getContext().getClient();
        this.uriInfo = session.getContext().getUri();
    }

関数詳解

addError()

LoginFormsProvider org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.addError ( FormMessage  errorMessage )

inline

                                                                 {
        if (this.messageType != MessageType.ERROR) {
            this.messageType = null;
            this.messages = null;
        }
        if (messages == null) {
            this.messageType = MessageType.ERROR;
            this.messages = new LinkedList<>();
        }
        this.messages.add(errorMessage);
        return this;

    }

addScript()

void org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.addScript ( String  scriptUrl )

inline

                                            {
        List<String> scripts = (List<String>) this.attributes.get("scripts");
        scripts.add(scriptUrl);
    }

addSuccess()

LoginFormsProvider org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.addSuccess ( FormMessage  errorMessage )

inline

                                                                   {
        if (this.messageType != MessageType.SUCCESS) {
            this.messageType = null;
            this.messages = null;
        }
        if (messages == null) {
            this.messageType = MessageType.SUCCESS;
            this.messages = new LinkedList<>();
        }
        this.messages.add(errorMessage);
        return this;

    }

close()

void org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.close ( )

inline

                        {
    }

createCode()

Response org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.createCode ( )

inline

                                 {
        return createResponse(LoginFormsPages.CODE);
    }

createCommonAttributes()

void org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.createCommonAttributes ( Theme  theme, Locale  locale, Properties  messagesBundle, UriBuilder  baseUriBuilder, LoginFormsPages  page  )

inlineprotected

Create common attributes used in all templates.

引数

theme	actual Theme used (provided by getTheme())
locale	actual locale
messagesBundle	actual message bundle (provided by handleThemeResources())
baseUriBuilder	actual base uri builder (provided by prepareBaseUriBuilder())
page	in case if common page is rendered, is null if called from createForm()

                                                                                                                                                  {
        URI baseUri = baseUriBuilder.build();
        if (accessCode != null) {
            baseUriBuilder.queryParam(LoginActionsService.SESSION_CODE, accessCode);
        }
        URI baseUriWithCodeAndClientId = baseUriBuilder.build();

        if (client != null) {
            attributes.put("client", new ClientBean(client, baseUri));
        }

        if (realm != null) {
            attributes.put("realm", new RealmBean(realm));

            List<IdentityProviderModel> identityProviders = realm.getIdentityProviders();
            identityProviders = LoginFormsUtil.filterIdentityProviders(identityProviders, session, realm, attributes, formData);
            attributes.put("social", new IdentityProviderBean(realm, session, identityProviders, baseUriWithCodeAndClientId));

            attributes.put("url", new UrlBean(realm, theme, baseUri, this.actionUri));
            attributes.put("requiredActionUrl", new RequiredActionUrlFormatterMethod(realm, baseUri));

            if (realm.isInternationalizationEnabled()) {
                UriBuilder b;
                if (page != null) {
                    switch (page) {
                        case LOGIN:
                            b = UriBuilder.fromUri(Urls.realmLoginPage(baseUri, realm.getName()));
                            break;
                        case X509_CONFIRM:
                            b = UriBuilder.fromUri(Urls.realmLoginPage(baseUri, realm.getName()));
                            break;
                        case REGISTER:
                            b = UriBuilder.fromUri(Urls.realmRegisterPage(baseUri, realm.getName()));
                            break;
                        default:
                            b = UriBuilder.fromUri(baseUri).path(uriInfo.getPath());
                            break;
                    }
                } else {
                    b = UriBuilder.fromUri(baseUri)
                            .path(uriInfo.getPath());
                }

                if (execution != null) {
                    b.queryParam(Constants.EXECUTION, execution);
                }

                if (authenticationSession != null && authenticationSession.getAuthNote(Constants.KEY) != null) {
                    b.queryParam(Constants.KEY, authenticationSession.getAuthNote(Constants.KEY));
                }

                attributes.put("locale", new LocaleBean(realm, locale, b, messagesBundle));
            }
        }
        if (realm != null && user != null && session != null) {
            attributes.put("authenticatorConfigured", new AuthenticatorConfiguredMethod(realm, user, session));
        }
    }

createErrorPage()

Response org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.createErrorPage ( Response.Status  status )

inline

                                                            {
        this.status = status;
        return createResponse(LoginFormsPages.ERROR);
    }

createForm()

Response org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.createForm ( String  form )

inline

                                            {
        Theme theme;
        try {
            theme = getTheme();
        } catch (IOException e) {
            logger.error("Failed to create theme", e);
            return Response.serverError().build();
        }

        Locale locale = session.getContext().resolveLocale(user);
        Properties messagesBundle = handleThemeResources(theme, locale);

        handleMessages(locale, messagesBundle);

        UriBuilder uriBuilder = prepareBaseUriBuilder(false);
        createCommonAttributes(theme, locale, messagesBundle, uriBuilder, null);

        return processTemplate(theme, form, locale);
    }

createIdpLinkConfirmLinkPage()

Response org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.createIdpLinkConfirmLinkPage ( )

inline

                                                   {
        return createResponse(LoginFormsPages.LOGIN_IDP_LINK_CONFIRM);
    }

createIdpLinkEmailPage()

Response org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.createIdpLinkEmailPage ( )

inline

                                             {
        BrokeredIdentityContext brokerContext = (BrokeredIdentityContext) this.attributes.get(IDENTITY_PROVIDER_BROKER_CONTEXT);
        String idpAlias = brokerContext.getIdpConfig().getAlias();
        idpAlias = ObjectUtil.capitalize(idpAlias);
        setMessage(MessageType.WARNING, Messages.LINK_IDP, idpAlias);

        return createResponse(LoginFormsPages.LOGIN_IDP_LINK_EMAIL);
    }

createInfoPage()

Response org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.createInfoPage ( )

inline

                                     {
        return createResponse(LoginFormsPages.INFO);
    }

createLogin()

Response org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.createLogin ( )

inline

                                  {
        return createResponse(LoginFormsPages.LOGIN);
    }

createLoginExpiredPage()

Response org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.createLoginExpiredPage ( )

inline

                                             {
        return createResponse(LoginFormsPages.LOGIN_PAGE_EXPIRED);
    }

createLoginTotp()

Response org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.createLoginTotp ( )

inline

                                      {
        return createResponse(LoginFormsPages.LOGIN_TOTP);
    }

createOAuthGrant()

Response org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.createOAuthGrant ( )

inline

                                       {
        return createResponse(LoginFormsPages.OAUTH_GRANT);
    }

createPasswordReset()

Response org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.createPasswordReset ( )

inline

                                          {
        return createResponse(LoginFormsPages.LOGIN_RESET_PASSWORD);
    }

createRegistration()

Response org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.createRegistration ( )

inline

                                         {
        return createResponse(LoginFormsPages.REGISTER);
    }

createResponse() [1/2]

Response org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.createResponse ( UserModel.RequiredAction  action )

inline

                                                                    {

        String actionMessage;
        LoginFormsPages page;

        switch (action) {
            case CONFIGURE_TOTP:
                actionMessage = Messages.CONFIGURE_TOTP;
                page = LoginFormsPages.LOGIN_CONFIG_TOTP;
                break;
            case UPDATE_PROFILE:
                UpdateProfileContext userBasedContext = new UserUpdateProfileContext(realm, user);
                this.attributes.put(UPDATE_PROFILE_CONTEXT_ATTR, userBasedContext);

                actionMessage = Messages.UPDATE_PROFILE;
                page = LoginFormsPages.LOGIN_UPDATE_PROFILE;
                break;
            case UPDATE_PASSWORD:
                boolean isRequestedByAdmin = user.getRequiredActions().stream().filter(Objects::nonNull).anyMatch(UPDATE_PASSWORD.toString()::contains);
                actionMessage = isRequestedByAdmin ? Messages.UPDATE_PASSWORD : Messages.RESET_PASSWORD;
                page = LoginFormsPages.LOGIN_UPDATE_PASSWORD;
                break;
            case VERIFY_EMAIL:
                actionMessage = Messages.VERIFY_EMAIL;
                page = LoginFormsPages.LOGIN_VERIFY_EMAIL;
                break;
            default:
                return Response.serverError().build();
        }

        if (messages == null) {
            setMessage(MessageType.WARNING, actionMessage);
        }

        return createResponse(page);
    }

createResponse() [2/2]

Response org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.createResponse ( LoginFormsPages  page )

inlineprotected

                                                            {
        Theme theme;
        try {
            theme = getTheme();
        } catch (IOException e) {
            logger.error("Failed to create theme", e);
            return Response.serverError().build();
        }

        Locale locale = session.getContext().resolveLocale(user);
        Properties messagesBundle = handleThemeResources(theme, locale);

        handleMessages(locale, messagesBundle);

        // for some reason Resteasy 2.3.7 doesn't like query params and form params with the same name and will null out the code form param
        UriBuilder uriBuilder = prepareBaseUriBuilder(page == LoginFormsPages.OAUTH_GRANT);
        createCommonAttributes(theme, locale, messagesBundle, uriBuilder, page);

        attributes.put("login", new LoginBean(formData));

        if (status != null) {
            attributes.put("statusCode", status.getStatusCode());
        }

        switch (page) {
            case LOGIN_CONFIG_TOTP:
                attributes.put("totp", new TotpBean(session, realm, user, uriInfo.getRequestUriBuilder()));
                break;
            case LOGIN_UPDATE_PROFILE:
                UpdateProfileContext userCtx = (UpdateProfileContext) attributes.get(LoginFormsProvider.UPDATE_PROFILE_CONTEXT_ATTR);
                attributes.put("user", new ProfileBean(userCtx, formData));
                break;
            case LOGIN_IDP_LINK_CONFIRM:
            case LOGIN_IDP_LINK_EMAIL:
                BrokeredIdentityContext brokerContext = (BrokeredIdentityContext) this.attributes.get(IDENTITY_PROVIDER_BROKER_CONTEXT);
                String idpAlias = brokerContext.getIdpConfig().getAlias();
                idpAlias = ObjectUtil.capitalize(idpAlias);

                attributes.put("brokerContext", brokerContext);
                attributes.put("idpAlias", idpAlias);
                break;
            case REGISTER:
                attributes.put("register", new RegisterBean(formData));
                break;
            case OAUTH_GRANT:
                attributes.put("oauth",
                        new OAuthGrantBean(accessCode, client, clientScopesRequested));
                attributes.put("advancedMsg", new AdvancedMessageFormatterMethod(locale, messagesBundle));
                break;
            case CODE:
                attributes.put(OAuth2Constants.CODE, new CodeBean(accessCode, messageType == MessageType.ERROR ? getFirstMessageUnformatted() : null));
                break;
            case X509_CONFIRM:
                attributes.put("x509", new X509ConfirmBean(formData));
                break;
        }

        return processTemplate(theme, Templates.getTemplate(page), locale);
    }

createUpdateProfilePage()

Response org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.createUpdateProfilePage ( )

inline

                                              {
        // Don't display initial message if we already have some errors
        if (messageType != MessageType.ERROR) {
            setMessage(MessageType.WARNING, Messages.UPDATE_PROFILE);
        }

        return createResponse(LoginFormsPages.LOGIN_UPDATE_PROFILE);
    }

createX509ConfirmPage()

Response org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.createX509ConfirmPage ( )

inline

                                            {
        return createResponse(LoginFormsPages.X509_CONFIRM);
    }

formatMessage()

String org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.formatMessage ( FormMessage  message, Properties  messagesBundle, Locale  locale  )

inlineprotected

                                                                                                  {
        if (message == null)
            return null;
        if (messagesBundle.containsKey(message.getMessage())) {
            return new MessageFormat(messagesBundle.getProperty(message.getMessage()), locale).format(message.getParameters());
        } else {
            return message.getMessage();
        }
    }

getFirstMessageUnformatted()

String org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.getFirstMessageUnformatted ( )

inlineprotected

                                                  {
        if (messages != null && !messages.isEmpty()) {
            return messages.get(0).getMessage();
        }
        return null;
    }

getMessage() [1/2]

String org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.getMessage ( String  message )

inline

                                             {
        Theme theme;
        try {
            theme = getTheme();
        } catch (IOException e) {
            logger.error("Failed to create theme", e);
            throw new RuntimeException("Failed to create theme");
        }

        Locale locale = session.getContext().resolveLocale(user);
        Properties messagesBundle = handleThemeResources(theme, locale);
        FormMessage msg = new FormMessage(null, message);
        return formatMessage(msg, messagesBundle, locale);
    }

getMessage() [2/2]

String org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.getMessage ( String  message, String...  parameters  )

inline

                                                                   {
        Theme theme;
        try {
            theme = getTheme();
        } catch (IOException e) {
            logger.error("Failed to create theme", e);
            throw new RuntimeException("Failed to create theme");
        }

        Locale locale = session.getContext().resolveLocale(user);
        Properties messagesBundle = handleThemeResources(theme, locale);
        FormMessage msg = new FormMessage(message, (Object[]) parameters);
        return formatMessage(msg, messagesBundle, locale);
    }

getTheme()

Theme org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.getTheme ( ) throws IOException

inlineprotected

Get Theme used for page rendering.

戻り値

theme for page rendering, never null

例外

IOException

in case of Theme loading problem

                                                  {
        return session.theme().getTheme(Theme.Type.LOGIN);
    }

handleMessages()

void org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.handleMessages ( Locale  locale, Properties  messagesBundle  )

inlineprotected

Handle messages to be shown on the page - set them to template attributes

引数

locale	to be used for message text loading
messagesBundle	to be used for message text loading

参照

messageType

messages

                                                                            {
        MessagesPerFieldBean messagesPerField = new MessagesPerFieldBean();
        if (messages != null) {
            MessageBean wholeMessage = new MessageBean(null, messageType);
            for (FormMessage message : this.messages) {
                String formattedMessageText = formatMessage(message, messagesBundle, locale);
                if (formattedMessageText != null) {
                    wholeMessage.appendSummaryLine(formattedMessageText);
                    messagesPerField.addMessage(message.getField(), formattedMessageText, messageType);
                }
            }
            attributes.put("message", wholeMessage);
        } else {
            attributes.put("message", null);
        }
        attributes.put("messagesPerField", messagesPerField);
    }

handleThemeResources()

Properties org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.handleThemeResources ( Theme  theme, Locale  locale  )

inlineprotected

Load message bundle and place it into msg template attribute. Also load Theme properties and place them into properties template attribute.

引数

theme	actual Theme to load bundle from
locale	to load bundle for

戻り値

message bundle for other use

                                                                          {
        Properties messagesBundle;
        try {
            messagesBundle = theme.getMessages(locale);
            attributes.put("msg", new MessageFormatterMethod(locale, messagesBundle));
        } catch (IOException e) {
            logger.warn("Failed to load messages", e);
            messagesBundle = new Properties();
        }

        try {
            attributes.put("properties", theme.getProperties());
        } catch (IOException e) {
            logger.warn("Failed to load properties", e);
        }

        return messagesBundle;
    }

prepareBaseUriBuilder()

UriBuilder org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.prepareBaseUriBuilder ( boolean  resetRequestUriParams )

inlineprotected

Prepare base uri builder for later use

引数

resetRequestUriParams

- for some reason Resteasy 2.3.7 doesn't like query params and form params with the same name and will null out the code form param, so we have to reset them for some pages

戻り値

base uri builder

                                                                              {
        String requestURI = uriInfo.getBaseUri().getPath();
        UriBuilder uriBuilder = UriBuilder.fromUri(requestURI);
        if (resetRequestUriParams) {
            uriBuilder.replaceQuery(null);
        }

        if (client != null) {
            uriBuilder.queryParam(Constants.CLIENT_ID, client.getClientId());
        }
        if (authenticationSession != null) {
            uriBuilder.queryParam(Constants.TAB_ID, authenticationSession.getTabId());
        }
        return uriBuilder;
    }

processTemplate()

Response org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.processTemplate ( Theme  theme, String  templateName, Locale  locale  )

inlineprotected

Process FreeMarker template and prepare Response. Some fields are used for rendering also.

引数

theme	to be used (provided by getTheme())
templateName	name of the template to be rendered
locale	to be used

戻り値

Response object to be returned to the browser, never null

                                                                                        {
        try {
            String result = freeMarker.processTemplate(attributes, templateName, theme);
            javax.ws.rs.core.MediaType mediaType = contentType == null ? MediaType.TEXT_HTML_UTF_8_TYPE : contentType;
            Response.ResponseBuilder builder = Response.status(status == null ? Response.Status.OK : status).type(mediaType).language(locale).entity(result);
            BrowserSecurityHeaderSetup.headers(builder, realm);
            for (Map.Entry<String, String> entry : httpResponseHeaders.entrySet()) {
                builder.header(entry.getKey(), entry.getValue());
            }
            return builder.build();
        } catch (FreeMarkerException e) {
            logger.error("Failed to process template", e);
            return Response.serverError().build();
        }
    }

setAccessRequest()

LoginFormsProvider org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.setAccessRequest ( List< ClientScopeModel >  clientScopesRequested )

inline

                                                                                             {
        this.clientScopesRequested = clientScopesRequested;
        return this;
    }

setActionUri()

LoginFormsProvider org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.setActionUri ( URI  actionUri )

inline

                                                          {
        this.actionUri = actionUri;
        return this;
    }

setAttribute()

LoginFormsProvider org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.setAttribute ( String  name, Object  value  )

inline

                                                                      {
        this.attributes.put(name, value);
        return this;
    }

setAuthenticationSession()

LoginFormsProvider org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.setAuthenticationSession ( AuthenticationSessionModel  authenticationSession )

inline

                                                                                                         {
        this.authenticationSession = authenticationSession;
        return this;
    }

setClientSessionCode()

LoginFormsProvider org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.setClientSessionCode ( String  accessCode )

inline

                                                                      {
        this.accessCode = accessCode;
        return this;
    }

setError()

FreeMarkerLoginFormsProvider org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.setError ( String  message, Object...  parameters  )

inline

                                                                                       {
        setMessage(MessageType.ERROR, message, parameters);
        return this;
    }

setErrors()

LoginFormsProvider org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.setErrors ( List< FormMessage >  messages )

inline

                                                                    {
        if (messages == null)
            return this;
        this.messageType = MessageType.ERROR;
        this.messages = new ArrayList<>(messages);
        return this;
    }

setExecution()

LoginFormsProvider org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.setExecution ( String  execution )

inline

                                                             {
        this.execution = execution;
        return this;
    }

setFormData()

FreeMarkerLoginFormsProvider org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.setFormData ( MultivaluedMap< String, String >  formData )

inline

                                                                                             {
        this.formData = formData;
        return this;
    }

setInfo()

FreeMarkerLoginFormsProvider org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.setInfo ( String  message, Object...  parameters  )

inline

                                                                                      {
        setMessage(MessageType.INFO, message, parameters);
        return this;
    }

setMediaType()

LoginFormsProvider org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.setMediaType ( javax.ws.rs.core.MediaType  type )

inline

                                                                            {
        this.contentType = type;
        return this;
    }

setMessage()

void org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.setMessage ( MessageType  type, String  message, Object...  parameters  )

inlineprotected

                                                                                      {
        messageType = type;
        messages = new ArrayList<>();
        messages.add(new FormMessage(null, message, parameters));
    }

setResponseHeader()

LoginFormsProvider org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.setResponseHeader ( String  headerName, String  headerValue  )

inline

                                                                                       {
        this.httpResponseHeaders.put(headerName, headerValue);
        return this;
    }

setStatus()

LoginFormsProvider org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.setStatus ( Response.Status  status )

inline

                                                                {
        this.status = status;
        return this;
    }

setSuccess()

FreeMarkerLoginFormsProvider org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.setSuccess ( String  message, Object...  parameters  )

inline

                                                                                         {
        setMessage(MessageType.SUCCESS, message, parameters);
        return this;
    }

setUser()

FreeMarkerLoginFormsProvider org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.setUser ( UserModel  user )

inline

                                                                {
        this.user = user;
        return this;
    }

メンバ詳解

accessCode

String org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.accessCode

protected

actionUri

URI org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.actionUri

protected

attributes

final Map<String, Object> org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.attributes = new HashMap<>()

protected

authenticationSession

AuthenticationSessionModel org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.authenticationSession

protected

authenticationSession can be null for some renderings, mainly error pages

client

ClientModel org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.client

protected

clientScopesRequested

List<ClientScopeModel> org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.clientScopesRequested

protected

contentType

javax.ws.rs.core.MediaType org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.contentType

protected

execution

String org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.execution

protected

formData

MultivaluedMap<String, String> org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.formData

protected

freeMarker

FreeMarkerUtil org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.freeMarker

protected

httpResponseHeaders

Map<String, String> org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.httpResponseHeaders = new HashMap<>()

protected

logger

final Logger org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.logger = Logger.getLogger(FreeMarkerLoginFormsProvider.class)

staticprivate

messages

List<FormMessage> org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.messages = null

protected

messageType

MessageType org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.messageType = MessageType.ERROR

protected

realm

RealmModel org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.realm

protected

session

KeycloakSession org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.session

protected

status

Response.Status org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.status

protected

uriInfo

UriInfo org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.uriInfo

protected

user

UserModel org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider.user

protected

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/rest-service/src/services/src/main/java/org/keycloak/forms/login/freemarker/FreeMarkerLoginFormsProvider.java