org.keycloak.locale.DefaultLocaleSelectorProvider クラス

org.keycloak.locale.DefaultLocaleSelectorProvider の継承関係図

org.keycloak.locale.DefaultLocaleSelectorProvider 連携図

公開メンバ関数
	DefaultLocaleSelectorProvider (KeycloakSession session)
Locale	resolveLocale (RealmModel realm, UserModel user)
void	close ()

限定公開メンバ関数
Locale	getLocale (RealmModel realm, UserModel user, HttpHeaders requestHeaders, UriInfo uriInfo)
Locale	getUserLocale (RealmModel realm, UserModel user, HttpHeaders requestHeaders, UriInfo uriInfo)
LocaleSelection	getKcLocaleQueryParamSelection (RealmModel realm, UriInfo uriInfo)
LocaleSelection	getLocaleCookieSelection (RealmModel realm, HttpHeaders httpHeaders)
LocaleSelection	getUserProfileSelection (RealmModel realm, UserModel user)
LocaleSelection	getUiLocalesQueryParamSelection (RealmModel realm, UriInfo uriInfo)
LocaleSelection	getAcceptLanguageHeaderLocale (RealmModel realm, HttpHeaders httpHeaders)
void	updateLocaleCookie (RealmModel realm, String locale, UriInfo uriInfo)
LocaleSelection	findLocale (RealmModel realm, String... localeStrings)
void	updateUsersLocale (UserModel user, String locale)

限定公開変数類
final KeycloakSession	session

静的限定公開変数類
static final String	LOCALE_COOKIE = "KEYCLOAK_LOCALE"
static final String	KC_LOCALE_PARAM = "kc_locale"

詳解

構築子と解体子

DefaultLocaleSelectorProvider()

org.keycloak.locale.DefaultLocaleSelectorProvider.DefaultLocaleSelectorProvider ( KeycloakSession  session )

inline

                                                                  {
        this.session = session;
    }

関数詳解

close()

void org.keycloak.locale.DefaultLocaleSelectorProvider.close ( )

inline

                        {

    }

findLocale()

LocaleSelection org.keycloak.locale.DefaultLocaleSelectorProvider.findLocale ( RealmModel  realm, String...  localeStrings  )

inlineprotected

                                                                                    {
        return new LocaleNegotiator(realm.getSupportedLocales()).invoke(localeStrings);
    }

getAcceptLanguageHeaderLocale()

LocaleSelection org.keycloak.locale.DefaultLocaleSelectorProvider.getAcceptLanguageHeaderLocale ( RealmModel  realm, HttpHeaders  httpHeaders  )

inlineprotected

                                                                                                       {
        if (httpHeaders == null || httpHeaders.getAcceptableLanguages() == null || httpHeaders.getAcceptableLanguages().isEmpty()) {
            return null;
        }
        for (Locale l : httpHeaders.getAcceptableLanguages()) {
            String localeString = l.toLanguageTag();
            LocaleSelection localeSelection = findLocale(realm, localeString);
            if (localeSelection != null) {
                return localeSelection;
            }
        }
        return null;
    }

getKcLocaleQueryParamSelection()

LocaleSelection org.keycloak.locale.DefaultLocaleSelectorProvider.getKcLocaleQueryParamSelection ( RealmModel  realm, UriInfo  uriInfo  )

inlineprotected

                                                                                                {
        if (uriInfo == null || !uriInfo.getQueryParameters().containsKey(KC_LOCALE_PARAM)) {
            return null;
        }
        String localeString = uriInfo.getQueryParameters().getFirst(KC_LOCALE_PARAM);
        return findLocale(realm, localeString);
    }

getLocale()

Locale org.keycloak.locale.DefaultLocaleSelectorProvider.getLocale ( RealmModel  realm, UserModel  user, HttpHeaders  requestHeaders, UriInfo  uriInfo  )

inlineprotected

                                                                                                              {
        if (!realm.isInternationalizationEnabled()) {
            return Locale.ENGLISH;
        } else {
            Locale locale = getUserLocale(realm, user, requestHeaders, uriInfo);
            return locale != null ? locale : Locale.forLanguageTag(realm.getDefaultLocale());
        }
    }

getLocaleCookieSelection()

LocaleSelection org.keycloak.locale.DefaultLocaleSelectorProvider.getLocaleCookieSelection ( RealmModel  realm, HttpHeaders  httpHeaders  )

inlineprotected

                                                                                                  {
        if (httpHeaders == null || !httpHeaders.getCookies().containsKey(LOCALE_COOKIE)) {
            return null;
        }
        String localeString = httpHeaders.getCookies().get(LOCALE_COOKIE).getValue();
        return findLocale(realm, localeString);
    }

getUiLocalesQueryParamSelection()

LocaleSelection org.keycloak.locale.DefaultLocaleSelectorProvider.getUiLocalesQueryParamSelection ( RealmModel  realm, UriInfo  uriInfo  )

inlineprotected

                                                                                                 {
        if (uriInfo == null || !uriInfo.getQueryParameters().containsKey(OAuth2Constants.UI_LOCALES_PARAM)) {
            return null;
        }
        String localeString = uriInfo.getQueryParameters().getFirst(OAuth2Constants.UI_LOCALES_PARAM);
        return findLocale(realm, localeString.split(" "));
    }

getUserLocale()

Locale org.keycloak.locale.DefaultLocaleSelectorProvider.getUserLocale ( RealmModel  realm, UserModel  user, HttpHeaders  requestHeaders, UriInfo  uriInfo  )

inlineprotected

                                                                                                                  {
        final LocaleSelection kcLocaleQueryParamSelection = getKcLocaleQueryParamSelection(realm, uriInfo);
        if (kcLocaleQueryParamSelection != null) {
            updateLocaleCookie(realm, kcLocaleQueryParamSelection.getLocaleString(), uriInfo);
            if (user != null) {
                updateUsersLocale(user, kcLocaleQueryParamSelection.getLocaleString());
            }
            return kcLocaleQueryParamSelection.getLocale();
        }

        final LocaleSelection localeCookieSelection = getLocaleCookieSelection(realm, requestHeaders);
        if (localeCookieSelection != null) {
            if (user != null) {
                updateUsersLocale(user, localeCookieSelection.getLocaleString());
            }
            return localeCookieSelection.getLocale();
        }

        final LocaleSelection userProfileSelection = getUserProfileSelection(realm, user);
        if (userProfileSelection != null) {
            updateLocaleCookie(realm, userProfileSelection.getLocaleString(), uriInfo);
            return userProfileSelection.getLocale();
        }

        final LocaleSelection uiLocalesQueryParamSelection = getUiLocalesQueryParamSelection(realm, uriInfo);
        if (uiLocalesQueryParamSelection != null) {
            return uiLocalesQueryParamSelection.getLocale();
        }

        final LocaleSelection acceptLanguageHeaderSelection = getAcceptLanguageHeaderLocale(realm, requestHeaders);
        if (acceptLanguageHeaderSelection != null) {
            return acceptLanguageHeaderSelection.getLocale();
        }

        return null;
    }

getUserProfileSelection()

LocaleSelection org.keycloak.locale.DefaultLocaleSelectorProvider.getUserProfileSelection ( RealmModel  realm, UserModel  user  )

inlineprotected

                                                                                        {
        if (user == null || !user.getAttributes().containsKey(UserModel.LOCALE)) {
            return null;
        }
        String localeString = user.getFirstAttribute(UserModel.LOCALE);
        return findLocale(realm, localeString);
    }

resolveLocale()

Locale org.keycloak.locale.DefaultLocaleSelectorProvider.resolveLocale ( RealmModel  realm, UserModel  user  )

inline

                                                                  {
        final HttpHeaders requestHeaders = session.getContext().getRequestHeaders();
        final UriInfo uri = session.getContext().getUri();
        return getLocale(realm, user, requestHeaders, uri);
    }

updateLocaleCookie()

void org.keycloak.locale.DefaultLocaleSelectorProvider.updateLocaleCookie ( RealmModel  realm, String  locale, UriInfo  uriInfo  )

inlineprotected

                                                                                        {
        boolean secure = realm.getSslRequired().isRequired(uriInfo.getRequestUri().getHost());
        CookieHelper.addCookie(LOCALE_COOKIE, locale, AuthenticationManager.getRealmCookiePath(realm, uriInfo), null, null, -1, secure, true);
    }

updateUsersLocale()

void org.keycloak.locale.DefaultLocaleSelectorProvider.updateUsersLocale ( UserModel  user, String  locale  )

inlineprotected

                                                                    {
        if (!locale.equals(user.getFirstAttribute("locale"))) {
            user.setSingleAttribute(UserModel.LOCALE, locale);
        }
    }

メンバ詳解

KC_LOCALE_PARAM

final String org.keycloak.locale.DefaultLocaleSelectorProvider.KC_LOCALE_PARAM = "kc_locale"

staticprotected

LOCALE_COOKIE

final String org.keycloak.locale.DefaultLocaleSelectorProvider.LOCALE_COOKIE = "KEYCLOAK_LOCALE"

staticprotected

session

final KeycloakSession org.keycloak.locale.DefaultLocaleSelectorProvider.session

protected

---

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

• D:/AppData/doxygen/keycloak/rest-service/src/services/src/main/java/org/keycloak/locale/DefaultLocaleSelectorProvider.java