README.md

Zanata Spring

This is a (very) small library providing an Spring MessageSource that delagates to the Zanata REST API.

Usage

Add the Maven dependency to your project (find the current version on Maven Central):

<dependency>
  <groupId>at.porscheinformatik.zanata</groupId>
  <artifactId>zanata-spring</artifactId>
  <version>${zanata-spring.version}</version>
</dependency>

Then declare the ZanataMessageSource as a bean. You can configure the MessageSource via:

• zanataBaseUrl (required) - the base URL of your Zanaza instance
• project (required) - the project id
• iteration - the iteration/version of the project, if not specified "master" will be used
• baseNames - the message bundle names, if not specified ["messages"] will be used

Usually you might want to have the local message bundles as a backup when Zanata is not running. Therefore you can set a ResourceBundleMessageSource as the parent of the ZanataMessageSource.

Here is a full example bean configuration for a Spring Boot app (with "messages" as the default bundle):

@Bean
public MessageSource messageSource() {
    ReloadableResourceBundleMessageSource localMessageSource = new ReloadableResourceBundleMessageSource();
    localMessageSource.setBasename("messages");
    localMessageSource.setFallbackToSystemLocale(false);

    ZanataMessageSource zanataMessageSource = new ZanataMessageSource();
    zanataMessageSource.setZanataBaseUrl("https://my-zanata.internal");
    zanataMessageSource.setProject("MY-ZANAZA-PROJECT");
    zanataMessageSource.setParentMessageSource(localMessageSource);
    return zanataMessageSource;
}

Authentication

If your Zanata instance needs authentication for accessing translations you can call ZanataMessageSource#useAuthentcation or provide your own RestTemplate and add a ZanataAuthenticationInterceptor.

Changes / Releases

See changelog.