org.exoplatform.services.resources.impl

Class BaseResourceBundleService

java.lang.Object

org.exoplatform.services.resources.impl.BaseResourceBundleService

All Implemented Interfaces:

ResourceBundleService, org.picocontainer.Startable

Direct Known Subclasses:

SimpleResourceBundleService

public abstract class BaseResourceBundleService
extends Object
implements ResourceBundleService, org.picocontainer.Startable

Created by The eXo Platform SAS Mar 9, 2007

Field Summary

Fields

Modifier and Type	Field and Description
protected org.exoplatform.services.cache.ExoCache<String,ResourceBundle>	cache_
protected ClassLoader	cl
protected List<String>	classpathResources_
protected List<String>	localeList_ List of local loaded
protected LocaleConfigService	localeService_
protected org.exoplatform.services.log.Log	log_
protected org.exoplatform.container.PortalContainer	portalContainer_
protected String[]	portalResourceBundleNames_

Constructor Summary

Constructors

Constructor and Description
BaseResourceBundleService()

Method Summary

Modifier and Type	Method and Description
void	addResourceBundle(BaseResourceBundlePlugin plugin) Add new resources bundles
ResourceBundleData	createResourceBundleDataInstance() This method is acted as a factory of
protected FutureCache<String,ResourceBundle,org.exoplatform.services.resources.impl.BaseResourceBundleService.ResourceBundleContext>	getFutureCache()
protected List<String>	getInitResources_()
ResourceBundle	getResourceBundle(String[] name, Locale locale) This method will call the method public ResourceBundle getResourceBundle(String[] name, Locale locale, ClassLoader cl) and using the the classloader of the current thread
ResourceBundle	getResourceBundle(String[] name, Locale locale, ClassLoader cl) This method will look for all the resources with the given names and merge into one resource bundle, the properties in the later resource bundle name will have the higher priority than the previous one.
ResourceBundle	getResourceBundle(String name, Locale locale) This method should search for a template in the database that the service manage or the resource in the classpath of the current thread class loader
ResourceBundle	getResourceBundle(String name, Locale locale, ClassLoader cl) This method should search for a template in the database that the service manage or the resource in the classpath of the specified class loader
protected String	getResourceBundleContent(String baseName, Locale locale, Locale defaultLocale, ClassLoader cl) This method is used for country support
protected String	getResourceBundleContent(String name, String language, String defaultLang, ClassLoader cl)
protected abstract ResourceBundle	getResourceBundleFromDb(String id, ResourceBundle parent, Locale locale)
String[]	getSharedResourceBundleNames() The developer can store the common properties in certain resource bundles so later he can merge a resource bundle with the shared resource bunldes
protected void	initParams(org.exoplatform.container.xml.InitParams params)
protected void	initResources(String baseName, Locale locale, ClassLoader cl)
protected void	invalidate(String name) Invalidate an entry in the cache at this level.
protected boolean	isClasspathResource(String name)
protected void	loadResourcesForLocale(Locale locale)
void	start() Loads all the "init" resource bundles
void	stop()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.exoplatform.services.resources.ResourceBundleService

findResourceDescriptions, getResourceBundleData, removeResourceBundleData, saveResourceBundle

Field Detail

log_

protected org.exoplatform.services.log.Log log_

cl

protected ClassLoader cl

localeList_

protected List<String> localeList_

List of local loaded

classpathResources_

protected volatile List<String> classpathResources_

portalResourceBundleNames_

protected volatile String[] portalResourceBundleNames_

localeService_

protected LocaleConfigService localeService_

cache_

protected org.exoplatform.services.cache.ExoCache<String,ResourceBundle> cache_

portalContainer_

protected org.exoplatform.container.PortalContainer portalContainer_

Constructor Detail

BaseResourceBundleService

public BaseResourceBundleService()

Method Detail

initParams

protected void initParams(org.exoplatform.container.xml.InitParams params)

addResourceBundle

public void addResourceBundle(BaseResourceBundlePlugin plugin)

Add new resources bundles

start

public void start()

Loads all the "init" resource bundles

Specified by:

start in interface org.picocontainer.Startable

See Also:

Startable.start()

stop

public void stop()

Specified by:

stop in interface org.picocontainer.Startable

See Also:

Startable.stop()

getResourceBundle

public ResourceBundle getResourceBundle(String[] name,
                                        Locale locale)

Description copied from interface: ResourceBundleService

This method will call the method public ResourceBundle getResourceBundle(String[] name, Locale locale, ClassLoader cl) and using the the classloader of the current thread

Specified by:

getResourceBundle in interface ResourceBundleService

getResourceBundle

public ResourceBundle getResourceBundle(String name,
                                        Locale locale)

Description copied from interface: ResourceBundleService

This method should search for a template in the database that the service manage or the resource in the classpath of the current thread class loader

Specified by:

getResourceBundle in interface ResourceBundleService

Parameters:

name - The name of the resource bunlde

locale - the locale

Returns:

A ResourceBunlde or null if no ResourceBundle is found

getSharedResourceBundleNames

public String[] getSharedResourceBundleNames()

Description copied from interface: ResourceBundleService

The developer can store the common properties in certain resource bundles so later he can merge a resource bundle with the shared resource bunldes

Specified by:

getSharedResourceBundleNames in interface ResourceBundleService

Returns:

the name of the shared resource bundle

createResourceBundleDataInstance

public ResourceBundleData createResourceBundleDataInstance()

Description copied from interface: ResourceBundleService

This method is acted as a factory of

Specified by:

createResourceBundleDataInstance in interface ResourceBundleService

Returns:

isClasspathResource

protected boolean isClasspathResource(String name)

initResources

protected void initResources(String baseName,
                             Locale locale,
                             ClassLoader cl)

getResourceBundleContent

protected String getResourceBundleContent(String name,
                                          String language,
                                          String defaultLang,
                                          ClassLoader cl)
                                   throws Exception

Throws:

Exception

getResourceBundleContent

protected String getResourceBundleContent(String baseName,
                                          Locale locale,
                                          Locale defaultLocale,
                                          ClassLoader cl)
                                   throws Exception

This method is used for country support

Parameters:

baseName -

locale -

defaultLocale -

cl -

Returns:

Throws:

Exception

getInitResources_

protected List<String> getInitResources_()

loadResourcesForLocale

protected void loadResourcesForLocale(Locale locale)

invalidate

protected final void invalidate(String name)

Invalidate an entry in the cache at this level. Normally this is called by the subclass.

Parameters:

name - the bundle name

getResourceBundle

public ResourceBundle getResourceBundle(String name,
                                        Locale locale,
                                        ClassLoader cl)

Description copied from interface: ResourceBundleService

This method should search for a template in the database that the service manage or the resource in the classpath of the specified class loader

Specified by:

getResourceBundle in interface ResourceBundleService

Parameters:

name - the name of the resource

locale - the locale

cl - The classloader

Returns:

getResourceBundle

public ResourceBundle getResourceBundle(String[] name,
                                        Locale locale,
                                        ClassLoader cl)

Description copied from interface: ResourceBundleService

This method will look for all the resources with the given names and merge into one resource bundle, the properties in the later resource bundle name will have the higher priority than the previous one.

Specified by:

getResourceBundle in interface ResourceBundleService

getFutureCache

protected FutureCache<String,ResourceBundle,org.exoplatform.services.resources.impl.BaseResourceBundleService.ResourceBundleContext> getFutureCache()

getResourceBundleFromDb

protected abstract ResourceBundle getResourceBundleFromDb(String id,
                                                          ResourceBundle parent,
                                                          Locale locale)
                                                   throws Exception

Throws:

Exception