com.communote.server.web.commons.i18n

Class JsMessagesRegistry

java.lang.Object

com.communote.server.web.commons.i18n.JsMessagesRegistry

All Implemented Interfaces:

EventListener<ResourceBundleChangedEvent>

public class JsMessagesRegistry
extends Object
implements EventListener<ResourceBundleChangedEvent>

Registry for localized Javascript messages with caching capabilities.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	CATEGORY_ADMINISTRATION Built-in category for JS messages required in the administration pages
static String	CATEGORY_COMMON Built-in category for JS messages required in pages like login, full screen messages, imprint, terms of use, registration
static String	CATEGORY_PORTAL Built-in category for JS messages required in the portal page

Constructor Summary

Constructors

Constructor and Description
JsMessagesRegistry() Creates the registry

Method Summary

Modifier and Type	Method and Description
void	addMessageKeys(String providerId, String category, Set<String> messageKeys) Add message keys to the named category.
String	getJsMessages(javax.servlet.http.HttpServletRequest request, String category) Returns a string representation of a Javascript object with the localized messages of the given category.
String	getJsMessages(Locale locale, String category) Returns a string representation of a Javascript object with the localized messages of the given category.
long	getLastModificationTimestamp(String category) Get timestamp of the last modification of the messages of the category.
Class<ResourceBundleChangedEvent>	getObservedEvent() Defines the types of events about which this listener will be informed.
void	handle(ResourceBundleChangedEvent event) Is called by the EventDispatcher when the observed event was fired.
void	removeMessageKeysOfProvider(String provider) Remove all message keys of the given provider.

Methods inherited from class java.lang.Object

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

Field Detail

CATEGORY_COMMON

public static final String CATEGORY_COMMON

Built-in category for JS messages required in pages like login, full screen messages, imprint, terms of use, registration

See Also:

Constant Field Values

CATEGORY_ADMINISTRATION

public static final String CATEGORY_ADMINISTRATION

Built-in category for JS messages required in the administration pages

See Also:

Constant Field Values

CATEGORY_PORTAL

public static final String CATEGORY_PORTAL

Built-in category for JS messages required in the portal page

See Also:

Constant Field Values

Constructor Detail

JsMessagesRegistry

public JsMessagesRegistry()

Creates the registry

Method Detail

addMessageKeys

public void addMessageKeys(String providerId,
                           String category,
                           Set<String> messageKeys)

Add message keys to the named category.

Parameters:

providerId - an identifier of the providing instance. This argument is required for removing the messages later on.

category - the category to extend with further message keys. This can be one of the built-in categories (use the CATEGORY_* constants) or a new one provided by a plugin.

messageKeys - the message keys to add

Throws:

IllegalArgumentException - in case the category is null, empty or blank

getJsMessages

public String getJsMessages(javax.servlet.http.HttpServletRequest request,
                            String category)

Returns a string representation of a Javascript object with the localized messages of the given category. The object will be in the format: {"key1":"value1","key2":"value2", ... , "keyN":"valueN" }

Parameters:

request - the current request

category - the category to retrieve. This can be one of the CATEGORY_* constants or a category defined by a plugin.

Returns:

the string representation of the Javascript object

getJsMessages

public String getJsMessages(Locale locale,
                            String category)

Returns a string representation of a Javascript object with the localized messages of the given category. The object will be in the format: {"key1":"value1","key2":"value2", ... , "keyN":"valueN" }

Parameters:

locale - the locale to use

category - the category to retrieve. This can be one of the CATEGORY_* constants or a category defined by a plugin.

Returns:

the string representation of the Javascript object

getLastModificationTimestamp

public long getLastModificationTimestamp(String category)

Get timestamp of the last modification of the messages of the category.

Parameters:

category - the name of the category

Returns:

the timestamp

getObservedEvent

public Class<ResourceBundleChangedEvent> getObservedEvent()

Description copied from interface: EventListener

Defines the types of events about which this listener will be informed.

Specified by:

getObservedEvent in interface EventListener<ResourceBundleChangedEvent>

Returns:

the class of the observed event

handle

public void handle(ResourceBundleChangedEvent event)

Description copied from interface: EventListener

Is called by the EventDispatcher when the observed event was fired.

Specified by:

handle in interface EventListener<ResourceBundleChangedEvent>

Parameters:

event - the event that was fired

removeMessageKeysOfProvider

public void removeMessageKeysOfProvider(String provider)

Remove all message keys of the given provider.

Parameters:

provider - the provider