org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider クラス

org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider の継承関係図

org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider 連携図

公開メンバ関数
	FreeMarkerAccountProvider (KeycloakSession session, FreeMarkerUtil freeMarker)
AccountProvider	setUriInfo (UriInfo uriInfo)
AccountProvider	setHttpHeaders (HttpHeaders httpHeaders)
Response	createResponse (AccountPages page)
AccountProvider	setPasswordSet (boolean passwordSet)
AccountProvider	setErrors (Response.Status status, List< FormMessage > messages)
AccountProvider	setError (Response.Status status, String message, Object ... parameters)
AccountProvider	setSuccess (String message, Object ... parameters)
AccountProvider	setWarning (String message, Object ... parameters)
AccountProvider	setUser (UserModel user)
AccountProvider	setProfileFormData (MultivaluedMap< String, String > formData)
AccountProvider	setRealm (RealmModel realm)
AccountProvider	setReferrer (String[] referrer)
AccountProvider	setEvents (List< Event > events)
AccountProvider	setSessions (List< UserSessionModel > sessions)
AccountProvider	setStateChecker (String stateChecker)
AccountProvider	setFeatures (boolean identityProviderEnabled, boolean eventsEnabled, boolean passwordUpdateSupported, boolean authorizationSupported)
AccountProvider	setAttribute (String key, String value)
void	close ()

限定公開メンバ関数
Theme	getTheme () throws IOException
Properties	handleThemeResources (Theme theme, Locale locale, Map< String, Object > attributes)
void	handleMessages (Locale locale, Properties messagesBundle, Map< String, Object > attributes)
Response	processTemplate (Theme theme, AccountPages page, Map< String, Object > attributes, Locale locale)
void	setMessage (MessageType type, String message, Object... parameters)
String	formatMessage (FormMessage message, Properties messagesBundle, Locale locale)

限定公開変数類
UserModel	user
MultivaluedMap< String, String >	profileFormData
Response.Status	status = Response.Status.OK
RealmModel	realm
String []	referrer
List< Event >	events
String	stateChecker
List< UserSessionModel >	sessions
boolean	identityProviderEnabled
boolean	eventsEnabled
boolean	passwordUpdateSupported
boolean	passwordSet
KeycloakSession	session
FreeMarkerUtil	freeMarker
HttpHeaders	headers
Map< String, Object >	attributes
UriInfo	uriInfo
List< FormMessage >	messages = null
MessageType	messageType = MessageType.ERROR

非公開変数類
boolean	authorizationSupported

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

詳解

著者

Stian Thorgersen

構築子と解体子

FreeMarkerAccountProvider()

org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.FreeMarkerAccountProvider ( KeycloakSession  session, FreeMarkerUtil  freeMarker  )

inline

                                                                                         {
        this.session = session;
        this.freeMarker = freeMarker;
    }

関数詳解

close()

void org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.close ( )

inline

                        {
    }

createResponse()

Response org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.createResponse ( AccountPages  page )

inline

                                                      {
        Map<String, Object> attributes = new HashMap<>();

        if (this.attributes != null) {
            attributes.putAll(this.attributes);
        }

        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, attributes);

        URI baseUri = uriInfo.getBaseUri();
        UriBuilder baseUriBuilder = uriInfo.getBaseUriBuilder();
        for (Map.Entry<String, List<String>> e : uriInfo.getQueryParameters().entrySet()) {
           baseUriBuilder.queryParam(e.getKey(), e.getValue().toArray());
        }
        URI baseQueryUri = baseUriBuilder.build();

        if (stateChecker != null) {
            attributes.put("stateChecker", stateChecker);
        }

        handleMessages(locale, messagesBundle, attributes);

        if (referrer != null) {
            attributes.put("referrer", new ReferrerBean(referrer));
        }

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

        attributes.put("url", new UrlBean(realm, theme, baseUri, baseQueryUri, uriInfo.getRequestUri(), stateChecker));

        if (realm.isInternationalizationEnabled()) {
            UriBuilder b = UriBuilder.fromUri(baseQueryUri).path(uriInfo.getPath());
            attributes.put("locale", new LocaleBean(realm, locale, b, messagesBundle));
        }

        attributes.put("features", new FeaturesBean(identityProviderEnabled, eventsEnabled, passwordUpdateSupported, authorizationSupported));
        attributes.put("account", new AccountBean(user, profileFormData));

        switch (page) {
            case TOTP:
                attributes.put("totp", new TotpBean(session, realm, user, uriInfo.getRequestUriBuilder()));
                break;
            case FEDERATED_IDENTITY:
                attributes.put("federatedIdentity", new AccountFederatedIdentityBean(session, realm, user, uriInfo.getBaseUri(), stateChecker));
                break;
            case LOG:
                attributes.put("log", new LogBean(events));
                break;
            case SESSIONS:
                attributes.put("sessions", new SessionsBean(realm, sessions));
                break;
            case APPLICATIONS:
                attributes.put("applications", new ApplicationsBean(session, realm, user));
                attributes.put("advancedMsg", new AdvancedMessageFormatterMethod(locale, messagesBundle));
                break;
            case PASSWORD:
                attributes.put("password", new PasswordBean(passwordSet));
                break;
            case RESOURCES:
                if (!realm.isUserManagedAccessAllowed()) {
                    return Response.status(Status.FORBIDDEN).build();
                }
                attributes.put("authorization", new AuthorizationBean(session, user, uriInfo));
            case RESOURCE_DETAIL:
                if (!realm.isUserManagedAccessAllowed()) {
                    return Response.status(Status.FORBIDDEN).build();
                }
                attributes.put("authorization", new AuthorizationBean(session, user, uriInfo));
        }

        return processTemplate(theme, page, attributes, locale);
    }

formatMessage()

String org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.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();
        }
    }

getTheme()

Theme org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.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.ACCOUNT);
    }

handleMessages()

void org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.handleMessages ( Locale  locale, Properties  messagesBundle, Map< String, Object >  attributes  )

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
attributes	template attributes to messages related info to

参照

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);
        }
        attributes.put("messagesPerField", messagesPerField);
    }

handleThemeResources()

Properties org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.handleThemeResources ( Theme  theme, Locale  locale, Map< String, Object >  attributes  )

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
attributes	template attributes to add resources to

戻り値

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;
    }

processTemplate()

Response org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.processTemplate ( Theme  theme, AccountPages  page, Map< String, Object >  attributes, Locale  locale  )

inlineprotected

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

引数

theme	to be used (provided by getTheme())
page	to be rendered
attributes	pushed to the template
locale	to be used

戻り値

Response object to be returned to the browser, never null

                                                                                                                      {
        try {
            String result = freeMarker.processTemplate(attributes, Templates.getTemplate(page), theme);
            Response.ResponseBuilder builder = Response.status(status).type(MediaType.TEXT_HTML_UTF_8_TYPE).language(locale).entity(result);
            BrowserSecurityHeaderSetup.headers(builder, realm);
            return builder.build();
        } catch (FreeMarkerException e) {
            logger.error("Failed to process template", e);
            return Response.serverError().build();
        }
    }

setAttribute()

AccountProvider org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.setAttribute ( String  key, String  value  )

inline

                                                                  {
        if (attributes == null) {
            attributes = new HashMap<>();
        }
        attributes.put(key, value);
        return this;
    }

setError()

AccountProvider org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.setError ( Response.Status  status, String  message, Object ...  parameters  )

inline

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

setErrors()

AccountProvider org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.setErrors ( Response.Status  status, List< FormMessage >  messages  )

inline

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

setEvents()

AccountProvider org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.setEvents ( List< Event >  events )

inline

                                                         {
        this.events = events;
        return this;
    }

setFeatures()

AccountProvider org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.setFeatures ( boolean  identityProviderEnabled, boolean  eventsEnabled, boolean  passwordUpdateSupported, boolean  authorizationSupported  )

inline

                                                                                                                                                                {
        this.identityProviderEnabled = identityProviderEnabled;
        this.eventsEnabled = eventsEnabled;
        this.passwordUpdateSupported = passwordUpdateSupported;
        this.authorizationSupported = authorizationSupported;
        return this;
    }

setHttpHeaders()

AccountProvider org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.setHttpHeaders ( HttpHeaders  httpHeaders )

inline

                                                                   {
        this.headers = httpHeaders;
        return this;
    }

setMessage()

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

inlineprotected

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

setPasswordSet()

AccountProvider org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.setPasswordSet ( boolean  passwordSet )

inline

                                                               {
        this.passwordSet = passwordSet;
        return this;
    }

setProfileFormData()

AccountProvider org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.setProfileFormData ( MultivaluedMap< String, String >  formData )

inline

                                                                                       {
        this.profileFormData = formData;
        return this;
    }

setRealm()

AccountProvider org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.setRealm ( RealmModel  realm )

inline

                                                      {
        this.realm = realm;
        return this;
    }

setReferrer()

AccountProvider org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.setReferrer ( String []  referrer )

inline

                                                          {
        this.referrer = referrer;
        return this;
    }

setSessions()

AccountProvider org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.setSessions ( List< UserSessionModel >  sessions )

inline

                                                                        {
        this.sessions = sessions;
        return this;
    }

setStateChecker()

AccountProvider org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.setStateChecker ( String  stateChecker )

inline

                                                                {
        this.stateChecker = stateChecker;
        return this;
    }

setSuccess()

AccountProvider org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.setSuccess ( String  message, Object ...  parameters  )

inline

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

setUriInfo()

AccountProvider org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.setUriInfo ( UriInfo  uriInfo )

inline

                                                       {
        this.uriInfo = uriInfo;
        return this;
    }

setUser()

AccountProvider org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.setUser ( UserModel  user )

inline

                                                   {
        this.user = user;
        return this;
    }

setWarning()

AccountProvider org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.setWarning ( String  message, Object ...  parameters  )

inline

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

メンバ詳解

attributes

Map<String, Object> org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.attributes

protected

authorizationSupported

boolean org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.authorizationSupported

private

events

List<Event> org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.events

protected

eventsEnabled

boolean org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.eventsEnabled

protected

freeMarker

FreeMarkerUtil org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.freeMarker

protected

headers

HttpHeaders org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.headers

protected

identityProviderEnabled

boolean org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.identityProviderEnabled

protected

logger

final Logger org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.logger = Logger.getLogger(FreeMarkerAccountProvider.class)

staticprivate

messages

List<FormMessage> org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.messages = null

protected

messageType

MessageType org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.messageType = MessageType.ERROR

protected

passwordSet

boolean org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.passwordSet

protected

passwordUpdateSupported

boolean org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.passwordUpdateSupported

protected

profileFormData

MultivaluedMap<String, String> org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.profileFormData

protected

realm

RealmModel org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.realm

protected

referrer

String [] org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.referrer

protected

session

KeycloakSession org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.session

protected

sessions

List<UserSessionModel> org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.sessions

protected

stateChecker

String org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.stateChecker

protected

status

Response.Status org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.status = Response.Status.OK

protected

uriInfo

UriInfo org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.uriInfo

protected

user

UserModel org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider.user

protected

---

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

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