com.communote.server.core.common.i18n

Class LocalizationManagement

java.lang.Object

com.communote.server.core.common.i18n.LocalizationManagement

@Service
 @Transactional(propagation=REQUIRES_NEW)
public class LocalizationManagement
extends Object

This class is responsible for managing custom messages within the database.

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
LocalizationManagement()

Method Summary

Modifier and Type	Method and Description
Map<Language,Message>	getAvailableLanguages(String messageKey, boolean resourceBundleFallback) Return for a given message key the localized message for each of the currently available languages
String	getCustomMessage(String messageKey, Locale locale) Method to get a custom localized message from the database.
LocalizedMessage	getCustomMessageFallback(String messageKey) Get a fallback that was set with setCustomMessageFallback(String, LocalizedMessage)
Message	getMessage(String messageKey, Locale locale) Method to get a custom localized message from the database.
void	removeCustomMessageFallback(String messageKey) Remove a fallback which was set with setCustomMessageFallback(String, LocalizedMessage)
void	setCustomMessageFallback(String messageKey, LocalizedMessage fallback) Set a falback for a custom message.
void	setMessage(String messageKey, String messageValue, String languageCode, boolean isHtml) Method to update or create message.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalizationManagement

public LocalizationManagement()

Method Detail

getAvailableLanguages

@Transactional(readOnly=true)
public Map<Language,Message> getAvailableLanguages(String messageKey,
                                                                                 boolean resourceBundleFallback)

Return for a given message key the localized message for each of the currently available languages

Parameters:

messageKey - The message key to load.

resourceBundlefallback - whether to return a fallback with the same key from the resource bundle if there is no message for the given key in the database

Returns:

Mapping from language to localized message. If no fallback should be returned or no fallback exists the message will be null.

getCustomMessage

@Transactional(readOnly=true)
public String getCustomMessage(String messageKey,
                                                             Locale locale)

Method to get a custom localized message from the database.

Parameters:

messageKey - The message key.

locale - The locale.

Returns:

The message from the database or a fallback value which was set via setCustomMessageFallback(String, LocalizedMessage) or from the local resources.

getCustomMessageFallback

@Transactional(propagation=SUPPORTS)
public LocalizedMessage getCustomMessageFallback(String messageKey)

Get a fallback that was set with setCustomMessageFallback(String, LocalizedMessage)

Parameters:

messageKey - the key of the message

Returns:

the fallback or null if there is no fallback

getMessage

@Transactional(readOnly=true)
public Message getMessage(String messageKey,
                                                        Locale locale)

Method to get a custom localized message from the database.

Parameters:

messageKey - The message key.

locale - The locale.

Returns:

The message from the database or null.

removeCustomMessageFallback

@Transactional(propagation=SUPPORTS)
public void removeCustomMessageFallback(String messageKey)

Remove a fallback which was set with setCustomMessageFallback(String, LocalizedMessage)

Parameters:

messageKey - the key of the fallback to remove

setCustomMessageFallback

@Transactional(propagation=SUPPORTS)
public void setCustomMessageFallback(String messageKey,
                                                                          LocalizedMessage fallback)

Set a falback for a custom message. If there is already a fallback for that key it will be overridden.

Parameters:

messageKey - the key of the fallback

fallback - the fallback

setMessage

public void setMessage(String messageKey,
                       String messageValue,
                       String languageCode,
                       boolean isHtml)

Method to update or create message.

Parameters:

messageKey - Key of the message.

messageValue - Value of the message.

languageCode - Language code.

isHtml - True, if this is html.