at.porscheinformatik.weblate.spring

Class WeblateMessageSource

java.lang.Object

org.springframework.context.support.MessageSourceSupport

org.springframework.context.support.AbstractMessageSource

at.porscheinformatik.weblate.spring.WeblateMessageSource

All Implemented Interfaces:

AllPropertiesSource, org.springframework.context.HierarchicalMessageSource, org.springframework.context.MessageSource

public class WeblateMessageSource
extends org.springframework.context.support.AbstractMessageSource
implements AllPropertiesSource

MessageSource loading texts from Weblate translation server via REST API.

If you use the WeblateMessageSource with a parent ReloadableResourceBundleMessageSource and want to resolve all properties you can use the AllPropertiesReloadableResourceBundleMessageSource instead.

Field Summary

Fields inherited from class org.springframework.context.support.MessageSourceSupport

logger

Constructor Summary

Constructors

Constructor and Description
WeblateMessageSource()

Method Summary

Modifier and Type	Method and Description
void	clearCache() Clears the cache for all locales and message bundles.
Properties	getAllProperties(Locale locale)
String	getBaseUrl()
Map<String,Locale>	getCodeToLocale()
String	getComponent()
Set<Locale>	getExistingLocales()
long	getInitialCacheTimestamp()
long	getMaxAgeMilis()
String	getProject()
String	getQuery()
void	registerLocaleMapping(String code, Locale locale) Registers a manual mapping of a Weblate code to a Locale.
void	reload(Locale... locales) Updates the translations for the given locales from Weblate.
void	reloadExistingLocales() Reload the cached list of existing locales.
void	removeEmptyCacheEntries() Remove cache entries that do not contain a translation.
protected MessageFormat	resolveCode(String code, Locale locale)
protected String	resolveCodeWithoutArguments(String code, Locale locale)
void	setBaseUrl(String baseUrl) Set Weblate base URL.
void	setCodeToLocale(Map<String,Locale> codeToLocale) Set the manual mapping of Weblate codes to Locales.
void	setComponent(String component) Set component.
void	setInitialCacheTimestamp(long initialCacheTimestamp) Set the timestamp that is used when no cache entry is set.
void	setMaxAgeMilis(long maxAgeMilis) Sets the max age for items in the cache (in milliseconds).
void	setProject(String project) Set project.
void	setQuery(String query) Set the Weblate query for extracting the texts.
void	setRestTemplate(org.springframework.web.client.RestTemplate restTemplate) Set the RestTemplate to use for getting data from Weblate REST API.
void	useAuthentication(String authToken) Sets WeblateAuthenticationInterceptor for calling the REST API.

Methods inherited from class org.springframework.context.support.AbstractMessageSource

getCommonMessages, getDefaultMessage, getDefaultMessage, getMessage, getMessage, getMessage, getMessageFromParent, getMessageInternal, getParentMessageSource, isUseCodeAsDefaultMessage, resolveArguments, setCommonMessages, setParentMessageSource, setUseCodeAsDefaultMessage

Methods inherited from class org.springframework.context.support.MessageSourceSupport

createMessageFormat, formatMessage, isAlwaysUseMessageFormat, renderDefaultMessage, setAlwaysUseMessageFormat

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WeblateMessageSource

public WeblateMessageSource()

Method Detail

getBaseUrl

public String getBaseUrl()

Returns:

the Weblate base URL

setBaseUrl

public void setBaseUrl(String baseUrl)

Set Weblate base URL.

Parameters:

baseUrl - the URL of your Weblate instance without trailing /

getProject

public String getProject()

Returns:

project slug in Weblate

setProject

public void setProject(String project)

Set project.

Parameters:

project - project slug in Weblate

getComponent

public String getComponent()

Returns:

component slug in Weblate

setComponent

public void setComponent(String component)

Set component.

Parameters:

component - component slug in Weblate

getInitialCacheTimestamp

public long getInitialCacheTimestamp()

Returns:

the initial cache timestamp

setInitialCacheTimestamp

public void setInitialCacheTimestamp(long initialCacheTimestamp)

Set the timestamp that is used when no cache entry is set. Default is 0.

This can be used when you have bundled translations that are provided via a parent message source. Only translations newer than this timestamp will ever be fetched from weblate.

Parameters:

initialCacheTimestamp - the initial cache timestamp

getQuery

public String getQuery()

Returns:

the Weblate query

setQuery

public void setQuery(String query)

Set the Weblate query for extracting the texts. Default is "state:>=translated"

See also: Weblate Search.

Parameters:

query - the Weblate query

getMaxAgeMilis

public long getMaxAgeMilis()

Returns:

the max age for items in the cache (in milliseconds)

setMaxAgeMilis

public void setMaxAgeMilis(long maxAgeMilis)

Sets the max age for items in the cache (in milliseconds).

Parameters:

maxAgeMilis - the max age for items in the cache (in milliseconds)

getExistingLocales

public Set<Locale> getExistingLocales()

Returns:

all existing locales of the configured weblate component

reloadExistingLocales

public void reloadExistingLocales()

Reload the cached list of existing locales.

This does not clear the cached translations.

setRestTemplate

public void setRestTemplate(org.springframework.web.client.RestTemplate restTemplate)

Set the RestTemplate to use for getting data from Weblate REST API.

Please configure the given parameter with UTF-8 as the standard message converter:

restTemplate.getMessageConverters().add(0, new StringHttpMessageConverter(StandardCharsets.UTF_8));

Parameters:

restTemplate - the RestTemplate

useAuthentication

public void useAuthentication(String authToken)

Sets WeblateAuthenticationInterceptor for calling the REST API. Be aware: this replaces all interceptors in the RestTemplate.

Parameters:

authToken - Weblate API token

getCodeToLocale

public Map<String,Locale> getCodeToLocale()

Returns:

the manual mapping Weblate codes to Locales

setCodeToLocale

public void setCodeToLocale(Map<String,Locale> codeToLocale)

Set the manual mapping of Weblate codes to Locales.

Parameters:

codeToLocale - the mapping

registerLocaleMapping

public void registerLocaleMapping(String code,
                                  Locale locale)

Registers a manual mapping of a Weblate code to a Locale.

Parameters:

code - the Weblate language code

locale - a Locale with

clearCache

public void clearCache()

Clears the cache for all locales and message bundles.

reload

public void reload(Locale... locales)

Updates the translations for the given locales from Weblate.

Only if the translations from Weblate could be loaded, the translation cache will be updated

Parameters:

locales - the locales that should be reloaded

removeEmptyCacheEntries

public void removeEmptyCacheEntries()

Remove cache entries that do not contain a translation.

This is useful e.g. when called after updating the existing locales. It ensures that newly found locales are available.

resolveCode

protected MessageFormat resolveCode(String code,
                                    Locale locale)

Specified by:

resolveCode in class org.springframework.context.support.AbstractMessageSource

resolveCodeWithoutArguments

protected String resolveCodeWithoutArguments(String code,
                                             Locale locale)

Overrides:

resolveCodeWithoutArguments in class org.springframework.context.support.AbstractMessageSource

getAllProperties

public Properties getAllProperties(Locale locale)

Specified by:

getAllProperties in interface AllPropertiesSource

Parameters:

locale - the locale to load the properties

Returns:

all properties provided for this locale