org.codehaus.groovy.grails.context.support

Class PluginAwareResourceBundleMessageSource

java.lang.Object

org.springframework.context.support.MessageSourceSupport

org.springframework.context.support.AbstractMessageSource

org.codehaus.groovy.grails.context.support.ReloadableResourceBundleMessageSource

org.codehaus.groovy.grails.context.support.PluginAwareResourceBundleMessageSource

All Implemented Interfaces:

PluginManagerAware, GrailsApplicationAware, org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.HierarchicalMessageSource, org.springframework.context.MessageSource, org.springframework.context.ResourceLoaderAware

public class PluginAwareResourceBundleMessageSource
extends ReloadableResourceBundleMessageSource
implements GrailsApplicationAware, PluginManagerAware, org.springframework.beans.factory.InitializingBean

A ReloadableResourceBundleMessageSource that is capable of loading message sources from plugins.

Since:

1.1

Nested Class Summary

Nested classes/interfaces inherited from class org.codehaus.groovy.grails.context.support.ReloadableResourceBundleMessageSource

ReloadableResourceBundleMessageSource.PropertiesHolder, ReloadableResourceBundleMessageSource.PropertiesHolderCacheEntry

Field Summary

Fields

Modifier and Type	Field and Description
protected GrailsApplication	application
protected java.util.List<java.lang.String>	pluginBaseNames
protected GrailsPluginManager	pluginManager

Fields inherited from class org.codehaus.groovy.grails.context.support.ReloadableResourceBundleMessageSource

cacheMillis, fileCacheMillis

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

logger

Constructor Summary

Constructors

Constructor and Description
PluginAwareResourceBundleMessageSource()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
protected java.lang.String	getInlinePluginPath(GrailsPlugin grailsPlugin) Returns the absolute path to the provided Grails plugin if it is being used "inline" or null if the plugin is not being used "inline".
protected ReloadableResourceBundleMessageSource.PropertiesHolder	getMergedBinaryPluginProperties(java.util.Locale locale)
protected ReloadableResourceBundleMessageSource.PropertiesHolder	getMergedPluginProperties(java.util.Locale locale) Get a PropertiesHolder that contains the actually visible properties for a Locale, after merging all specified resource bundles.
java.util.List<java.lang.String>	getPluginBaseNames()
protected org.springframework.core.io.Resource[]	getPluginBundles(GrailsPlugin grailsPlugin) Returns the i18n message bundles for the provided plugin or an empty array if the plugin does not contain any .properties files in its grails-app/i18n folder.
protected boolean	isInlinePlugin(GrailsPlugin grailsPlugin) Tests whether or not the Grails plugin is currently being run "inline".
protected void	mergeBinaryPluginProperties(java.util.Locale locale, java.util.Properties mergedProps)
protected java.text.MessageFormat	resolveCode(java.lang.String code, java.util.Locale locale) Resolves the given message code as key in the retrieved bundle files, using a cached MessageFormat instance per message code.
protected java.text.MessageFormat	resolveCodeFromPlugins(java.lang.String code, java.util.Locale locale) Attempts to resolve a MessageFormat for the code from the list of plugin base names
protected java.lang.String	resolveCodeWithoutArguments(java.lang.String code, java.util.Locale locale) Resolves the given message code as key in the retrieved bundle files, returning the value found in the bundle as-is (without MessageFormat parsing).
protected java.lang.String	resolveCodeWithoutArgumentsFromPlugins(java.lang.String code, java.util.Locale locale) Attempts to resolve a String for the code from the list of plugin base names
void	setGrailsApplication(GrailsApplication grailsApplication) This method is called by the ApplicationContext that loads the Grails application.
void	setPluginBaseNames(java.util.List<java.lang.String> pluginBaseNames)
void	setPluginCacheSeconds(int pluginCacheSeconds) Set the number of seconds to cache the list of matching properties files loaded from plugin.
void	setPluginManager(GrailsPluginManager pluginManager) Sets the plug-in manager on this instance
void	setResourceLoader(org.springframework.core.io.ResourceLoader resourceLoader) Set the ResourceLoader to use for loading bundle properties files.
void	setResourceResolver(org.springframework.core.io.support.PathMatchingResourcePatternResolver resourceResolver)

Methods inherited from class org.codehaus.groovy.grails.context.support.ReloadableResourceBundleMessageSource

calculateAllFilenames, calculateFilenamesForLocale, clearCache, clearCacheIncludingAncestors, getMergedProperties, getProperties, loadProperties, locateResource, locateResourceWithoutCache, setBasename, setBasenames, setCacheSeconds, setDefaultEncoding, setFallbackToSystemLocale, setFileCacheSeconds, setFileEncodings, setPropertiesPersister, toString

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

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

Field Detail

application

protected GrailsApplication application

pluginManager

protected GrailsPluginManager pluginManager

pluginBaseNames

protected java.util.List<java.lang.String> pluginBaseNames

Constructor Detail

PluginAwareResourceBundleMessageSource

public PluginAwareResourceBundleMessageSource()

Method Detail

getPluginBaseNames

public java.util.List<java.lang.String> getPluginBaseNames()

setPluginBaseNames

public void setPluginBaseNames(java.util.List<java.lang.String> pluginBaseNames)

setGrailsApplication

public void setGrailsApplication(GrailsApplication grailsApplication)

Description copied from interface: GrailsApplicationAware

This method is called by the ApplicationContext that loads the Grails application. The GrailsApplication instance that represents the loaded Grails application is injected.

Specified by:

setGrailsApplication in interface GrailsApplicationAware

Parameters:

grailsApplication - the GrailsApplication object that represents this Grails application

setPluginManager

public void setPluginManager(GrailsPluginManager pluginManager)

Description copied from interface: PluginManagerAware

Sets the plug-in manager on this instance

Specified by:

setPluginManager in interface PluginManagerAware

Parameters:

pluginManager - The PluginManager

setResourceResolver

public void setResourceResolver(org.springframework.core.io.support.PathMatchingResourcePatternResolver resourceResolver)

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

java.lang.Exception

getPluginBundles

protected org.springframework.core.io.Resource[] getPluginBundles(GrailsPlugin grailsPlugin)

Returns the i18n message bundles for the provided plugin or an empty array if the plugin does not contain any .properties files in its grails-app/i18n folder.

Parameters:

grailsPlugin - The grails plugin that may or may not contain i18n internationalization files.

Returns:

An array of Resource objects representing the internationalization files or an empty array if no files are found.

isInlinePlugin

protected boolean isInlinePlugin(GrailsPlugin grailsPlugin)

Tests whether or not the Grails plugin is currently being run "inline".

Parameters:

grailsPlugin - The Grails plugin to test.

Returns:

true if the plugin is being used "inline" or false if the plugin is not being used "inline".

getInlinePluginPath

protected java.lang.String getInlinePluginPath(GrailsPlugin grailsPlugin)

Returns the absolute path to the provided Grails plugin if it is being used "inline" or null if the plugin is not being used "inline".

Parameters:

grailsPlugin - The Grails plugin.

Returns:

The absolute path to the "inline" plugin or null if the plugin is not being used "inline".

resolveCodeWithoutArguments

protected java.lang.String resolveCodeWithoutArguments(java.lang.String code,
                                                       java.util.Locale locale)

Description copied from class: ReloadableResourceBundleMessageSource

Resolves the given message code as key in the retrieved bundle files, returning the value found in the bundle as-is (without MessageFormat parsing).

Overrides:

resolveCodeWithoutArguments in class ReloadableResourceBundleMessageSource

resolveCode

protected java.text.MessageFormat resolveCode(java.lang.String code,
                                              java.util.Locale locale)

Description copied from class: ReloadableResourceBundleMessageSource

Resolves the given message code as key in the retrieved bundle files, using a cached MessageFormat instance per message code.

Overrides:

resolveCode in class ReloadableResourceBundleMessageSource

getMergedPluginProperties

protected ReloadableResourceBundleMessageSource.PropertiesHolder getMergedPluginProperties(java.util.Locale locale)

Get a PropertiesHolder that contains the actually visible properties for a Locale, after merging all specified resource bundles. Either fetches the holder from the cache or freshly loads it.

Only used when caching resource bundle contents forever, i.e. with cacheSeconds < 0. Therefore, merged properties are always cached forever.

resolveCodeWithoutArgumentsFromPlugins

protected java.lang.String resolveCodeWithoutArgumentsFromPlugins(java.lang.String code,
                                                                  java.util.Locale locale)

Attempts to resolve a String for the code from the list of plugin base names

Parameters:

code - The code

locale - The locale

Returns:

a MessageFormat

getMergedBinaryPluginProperties

protected ReloadableResourceBundleMessageSource.PropertiesHolder getMergedBinaryPluginProperties(java.util.Locale locale)

mergeBinaryPluginProperties

protected void mergeBinaryPluginProperties(java.util.Locale locale,
                                           java.util.Properties mergedProps)

resolveCodeFromPlugins

protected java.text.MessageFormat resolveCodeFromPlugins(java.lang.String code,
                                                         java.util.Locale locale)

Attempts to resolve a MessageFormat for the code from the list of plugin base names

Parameters:

code - The code

locale - The locale

Returns:

a MessageFormat

setResourceLoader

public void setResourceLoader(org.springframework.core.io.ResourceLoader resourceLoader)

Description copied from class: ReloadableResourceBundleMessageSource

Set the ResourceLoader to use for loading bundle properties files.

The default is a DefaultResourceLoader. Will get overridden by the ApplicationContext if running in a context, as it implements the ResourceLoaderAware interface. Can be manually overridden when running outside of an ApplicationContext.

Specified by:

setResourceLoader in interface org.springframework.context.ResourceLoaderAware

Overrides:

setResourceLoader in class ReloadableResourceBundleMessageSource

See Also:

DefaultResourceLoader, ResourceLoaderAware

setPluginCacheSeconds

public void setPluginCacheSeconds(int pluginCacheSeconds)

Set the number of seconds to cache the list of matching properties files loaded from plugin.

• Default value is the same value as cacheSeconds