libre.sh/keycloak-scim
3
0
Fork 0
Code Issues 15 Pull requests Releases Packages Activity Actions

KEYCLOAK-8146 Document the LocaleSelectorSPI for server development

Browse source
This commit is contained in:
Johannes Knutsen 2018-09-05 23:42:47 +02:00 committed by Marek Posolda
parent dcbee72e99
commit 2f09b8a810
3 changed files with 22 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
server_development/topics.adoc
View file

@ -3,6 +3,7 @@ include::topics/admin-rest-api.adoc[]
include::topics/themes.adoc[]
include::topics/themes-selector.adoc[]
include::topics/themes-resources.adoc[]
include::topics/locale-selector.adoc[]
include::topics/custom-attributes.adoc[]
include::topics/identity-brokering.adoc[]
include::topics/identity-brokering/tokens.adoc[]

19
server_development/topics/locale-selector.adoc Normal file
View file

@ -0,0 +1,19 @@
[[_locale_selector]]
=== Locale Selector
By default, the locale is selected using the `DefaultLocaleSelectorProvider` which implements the `LocaleSelectorProvider` interface. English is the default language when internationalization is disabled. With internationalization enabled, the locale is resolved in the following priority:
. `kc_locale` query parameter
. `KEYCLOAK_LOCALE` cookie value
. User's preferred locale if a user instance is available
. `ui_locales` query parameter
. `Accept-Language` request header
. Realm's default language
This behaviour can be changed through the `LocaleSelectorSPI` by implementing the `LocaleSelectorProvider` and `LocaleSelectorProviderFactory`.
The `LocaleSelectorProvider` interface has a single method, `resolveLocale`, which must return a locale given a `RealmModel` and a nullable `UserModel`. The actual request is available from the `KeycloakSession#getContext` method.
Custom implementations can extend the `DefaultLocaleSelectorProvider` in order to reuse parts of the default behaviour. For example to ignore the `Accept-Language` request header, a custom implementation could extend the default provider, override it's `getAcceptLanguageHeaderLocale`, and return a null value. As a result the locale selection will fall back on the realms's default language.
Follow the steps in <<_providers,Service Provider Interfaces>> for more details on how to create and deploy a custom provider.

2
server_development/topics/themes.adoc
View file

@ -253,6 +253,8 @@ By default message properties files should be encoded using ISO-8859-1. It's als
usernameOrEmail=....
----
See <<_locale_selector,Locale Selector>> on details on how the current locale is selected.
==== HTML Templates
{project_name} uses https://freemarker.apache.org/[Freemarker Templates] in order to generate HTML. You can override individual templates in your own theme by