Package org.keycloak.admin.client.resource

Interface RealmLocalizationResource

public interface RealmLocalizationResource

Method Summary

Modifier and Type	Method	Description
void	createOrUpdateRealmLocalizationTexts(String locale, Map<String,String> localizationTexts)
void	deleteRealmLocalizationText(String locale, String key)
void	deleteRealmLocalizationTexts(String locale)
String	getRealmLocalizationText(String locale, String key)
Map<String,String>	getRealmLocalizationTexts(String locale)	Get the localization texts for the given locale.
Map<String,String>	getRealmLocalizationTexts(String locale, Boolean useRealmDefaultLocaleFallback)	Deprecated. use getRealmLocalizationTexts(String), in order to retrieve localization texts without fallbacks.
List<String>	getRealmSpecificLocales()
void	saveRealmLocalizationText(String locale, String key, String text)

Method Details

getRealmSpecificLocales

@GET
@Produces("application/json")
List<String> getRealmSpecificLocales()

getRealmLocalizationTexts

@Path("{locale}")
@GET
@Produces("application/json")
Map<String,String> getRealmLocalizationTexts(@PathParam("locale")
 String locale)

Get the localization texts for the given locale.

Parameters:

locale - the locale

Returns:

the localization texts

getRealmLocalizationTexts

@Deprecated
@Path("{locale}")
@GET
@Produces("application/json")
Map<String,String> getRealmLocalizationTexts(@PathParam("locale")
 String locale,
 @QueryParam("useRealmDefaultLocaleFallback")
 Boolean useRealmDefaultLocaleFallback)

Deprecated.

use getRealmLocalizationTexts(String), in order to retrieve localization texts without fallbacks. If you need fallbacks, call the endpoint multiple time with all the relevant locales (e.g. "de" in case of "de-CH") - the realm default locale is NOT the only fallback to be considered.

DEPRECATED - Get the localization texts for the given locale.

Parameters:

locale - the locale

useRealmDefaultLocaleFallback - whether the localization texts for the realm default locale should be used as fallbacks in the result

Returns:

the localization texts

getRealmLocalizationText

@Path("{locale}/{key}")
@GET
@Produces("text/plain")
String getRealmLocalizationText(@PathParam("locale")
 String locale,
 @PathParam("key")
 String key)

deleteRealmLocalizationTexts

@Path("{locale}")
@DELETE
void deleteRealmLocalizationTexts(@PathParam("locale")
 String locale)

deleteRealmLocalizationText

@Path("{locale}/{key}")
@DELETE
void deleteRealmLocalizationText(@PathParam("locale")
 String locale,
 @PathParam("key")
 String key)

saveRealmLocalizationText

@Path("{locale}/{key}")
@PUT
@Consumes("text/plain")
void saveRealmLocalizationText(@PathParam("locale")
 String locale,
 @PathParam("key")
 String key,
 String text)

createOrUpdateRealmLocalizationTexts

@Path("{locale}")
@POST
@Consumes("application/json")
void createOrUpdateRealmLocalizationTexts(@PathParam("locale")
 String locale,
 Map<String,String> localizationTexts)