org.onehippo.forge.hst.spring.support

Class HstRepositoryResourceBundleMessageSource

java.lang.Object

org.springframework.context.support.MessageSourceSupport

org.springframework.context.support.AbstractMessageSource

org.springframework.context.support.AbstractResourceBasedMessageSource

org.springframework.context.support.ResourceBundleMessageSource

org.onehippo.forge.hst.spring.support.HstRepositoryResourceBundleMessageSource

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.context.HierarchicalMessageSource, org.springframework.context.MessageSource

public class HstRepositoryResourceBundleMessageSource
extends org.springframework.context.support.ResourceBundleMessageSource

MessageSource implementation that accesses Config.get(javax.servlet.ServletRequest, String) to read the default LocalizationContext which can be set by HST-2 Container (LocalizationValve). (if isLocalizationContextResourceBundleEnabled() returns true (by default)) to resolve MessageFormat. If falls back to the super class, ResourceBundleMessageSource, if nothing found (from HST-2 Dynamic Resource Bundles).

Field Summary

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

logger

Constructor Summary

Constructors

Constructor and Description
HstRepositoryResourceBundleMessageSource() Zero-argument default constructor.

Method Summary

Modifier and Type	Method and Description
protected ResourceBundle	findDefaultResourceBundle() Finds the default LocalizationContext's ResourceBundle set by HST-2 Container in the frontend pipeline.
protected MessageFormat	getMessageFormat(ResourceBundle bundle, String code, Locale locale) Return a MessageFormat for the given bundle and code, fetching already generated MessageFormats from the cache.
protected MessageFormat	getMessageFormatFromDefaultResourceBundle(ResourceBundle defaultResourceBundle, String code, Locale locale) Invokes RepositoryResourceBundleMessageFormatProvider.registerBundle(String, Locale, ResourceBundle) or RepositoryResourceBundleMessageFormatProvider.registerPreviewBundle(String, Locale, ResourceBundle) depending on the current request context in order to register the bundle or remove any existing outdated bundle.
protected ResourceBundle	getResourceBundle(String basename, Locale locale) If isRepositoryResourceBundleEnabled() returns true, then it first looks up resource bundle from the repository.
RepositoryResourceBundleMessageFormatProvider	getResourceBundleMessageFormatProvider() Returns RepositoryResourceBundleMessageFormatProvider internally used for maintaining repository-based resource bundles and message formats from them.
protected String	getStringOrNull(ResourceBundle bundle, String key)
boolean	isLocalizationContextResourceBundleEnabled() Returns true if the default resource bundle should be found from LocalizationContext by calling on Config.get(javax.servlet.ServletRequest, String).
boolean	isRepositoryResourceBundleEnabled() Returns true if the repository resource bundle documents should be looked up in getResourceBundle(String, Locale).
protected MessageFormat	resolveCode(String code, Locale locale) If isLocalizationContextResourceBundleEnabled() returns true, then it tries to find the default resource bundle from LocalizationContext first.
protected String	resolveCodeWithoutArguments(String code, Locale locale) If isLocalizationContextResourceBundleEnabled() returns true, then it tries to find the default resource bundle from LocalizationContext first.
void	setLocalizationContextResourceBundleEnabled(boolean localizationContextResourceBundleEnabled) Sets the flag whether or not the default resource bundle should be found from LocalizationContext by calling on Config.get(javax.servlet.ServletRequest, String).
void	setRepositoryResourceBundleEnabled(boolean repositoryResourceBundleEnabled) Sets the flag whether or not the repository resource bundle documents should be looked up in getResourceBundle(String, Locale).
void	setResourceBundleMessageFormatProvider(RepositoryResourceBundleMessageFormatProvider resourceBundleMessageFormatProvider) Sets RepositoryResourceBundleMessageFormatProvider internally to be used for maintaining repository-based resource bundles and message formats from them.

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

doGetBundle, getBundleClassLoader, loadBundle, loadBundle, setBeanClassLoader, setBundleClassLoader, toString

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

addBasenames, getBasenameSet, getCacheMillis, getDefaultEncoding, isFallbackToSystemLocale, setBasename, setBasenames, setCacheMillis, setCacheSeconds, setDefaultEncoding, setFallbackToSystemLocale

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, wait, wait, wait

Constructor Detail

HstRepositoryResourceBundleMessageSource

public HstRepositoryResourceBundleMessageSource()

Zero-argument default constructor.

Method Detail

isLocalizationContextResourceBundleEnabled

public boolean isLocalizationContextResourceBundleEnabled()

Returns true if the default resource bundle should be found from LocalizationContext by calling on Config.get(javax.servlet.ServletRequest, String).

Returns:

true if the default resource bundle should be found from LocalizationContext by calling on Config.get(javax.servlet.ServletRequest, String)

setLocalizationContextResourceBundleEnabled

public void setLocalizationContextResourceBundleEnabled(boolean localizationContextResourceBundleEnabled)

Sets the flag whether or not the default resource bundle should be found from LocalizationContext by calling on Config.get(javax.servlet.ServletRequest, String).

Parameters:

localizationContextResourceBundleEnabled - the flag whether or not the default resource bundle should be found from LocalizationContext by calling on Config.get(javax.servlet.ServletRequest, String)

isRepositoryResourceBundleEnabled

public boolean isRepositoryResourceBundleEnabled()

Returns true if the repository resource bundle documents should be looked up in getResourceBundle(String, Locale).

Returns:

true if the repository resource bundle documents should be looked up in getResourceBundle(String, Locale)

setRepositoryResourceBundleEnabled

public void setRepositoryResourceBundleEnabled(boolean repositoryResourceBundleEnabled)

Sets the flag whether or not the repository resource bundle documents should be looked up in getResourceBundle(String, Locale).

Parameters:

repositoryResourceBundleEnabled - the flag whether or not the repository resource bundle documents should be looked up in getResourceBundle(String, Locale)

getResourceBundleMessageFormatProvider

public RepositoryResourceBundleMessageFormatProvider getResourceBundleMessageFormatProvider()

Returns RepositoryResourceBundleMessageFormatProvider internally used for maintaining repository-based resource bundles and message formats from them.

Returns:

RepositoryResourceBundleMessageFormatProvider internally used for maintaining repository-based resource bundles and message formats from them

setResourceBundleMessageFormatProvider

public void setResourceBundleMessageFormatProvider(RepositoryResourceBundleMessageFormatProvider resourceBundleMessageFormatProvider)

Sets RepositoryResourceBundleMessageFormatProvider internally to be used for maintaining repository-based resource bundles and message formats from them.

Parameters:

resourceBundleMessageFormatProvider - RepositoryResourceBundleMessageFormatProvider internally to be used for maintaining repository-based resource bundles and message formats from them

resolveCodeWithoutArguments

protected String resolveCodeWithoutArguments(String code,
                                             Locale locale)

If isLocalizationContextResourceBundleEnabled() returns true, then it tries to find the default resource bundle from LocalizationContext first. Otherwise or if not found, it proceeds with the default behavior.

Overrides:

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

Parameters:

code - message code

locale - message locale

Returns:

message resolved by the code and locale

resolveCode

protected MessageFormat resolveCode(String code,
                                    Locale locale)

If isLocalizationContextResourceBundleEnabled() returns true, then it tries to find the default resource bundle from LocalizationContext first. Otherwise or if not found, it proceeds with the default behavior.

Overrides:

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

Parameters:

code - message code

locale - message locale

Returns:

message format resolved by code and locale

getResourceBundle

protected ResourceBundle getResourceBundle(String basename,
                                           Locale locale)

If isRepositoryResourceBundleEnabled() returns true, then it first looks up resource bundle from the repository. Otherwise or if not found, it proceeds with the default behavior.

Overrides:

getResourceBundle in class org.springframework.context.support.ResourceBundleMessageSource

Parameters:

basename - resource bundle basename

locale - resource bundle locale

Returns:

resource bundle

getMessageFormat

protected MessageFormat getMessageFormat(ResourceBundle bundle,
                                         String code,
                                         Locale locale)
                                  throws MissingResourceException

Return a MessageFormat for the given bundle and code, fetching already generated MessageFormats from the cache.

Overrides:

getMessageFormat in class org.springframework.context.support.ResourceBundleMessageSource

Parameters:

bundle - resource bundle

code - message code

locale - message locale

Returns:

message format resolved

Throws:

MissingResourceException

getMessageFormatFromDefaultResourceBundle

protected MessageFormat getMessageFormatFromDefaultResourceBundle(ResourceBundle defaultResourceBundle,
                                                                  String code,
                                                                  Locale locale)

Invokes RepositoryResourceBundleMessageFormatProvider.registerBundle(String, Locale, ResourceBundle) or RepositoryResourceBundleMessageFormatProvider.registerPreviewBundle(String, Locale, ResourceBundle) depending on the current request context in order to register the bundle or remove any existing outdated bundle. And, it invokes getMessageFormat(ResourceBundle, String, Locale) to return a MessageFormat.

Parameters:

defaultResourceBundle - default resource bundle

code - message code

locale - message locale

Returns:

message format resolved

findDefaultResourceBundle

protected ResourceBundle findDefaultResourceBundle()

Finds the default LocalizationContext's ResourceBundle set by HST-2 Container in the frontend pipeline.

It tries to find it from the JSTL LocalizationContext. However, JstlView (and JstlUtils) of Spring Framework may replace the LocalizationContext by its MessageSourceResourceBundle. In that case, it tries to resolve the default resource bundle(s) configured in HST-2 configurations again.

Returns:

default resource bundle

getStringOrNull

protected String getStringOrNull(ResourceBundle bundle,
                                 String key)

Overrides:

getStringOrNull in class org.springframework.context.support.ResourceBundleMessageSource