com.bea.netuix.servlets.l10n
Class L10nResourceManager

java.lang.Object
  |
  +--com.bea.netuix.servlets.l10n.L10nResourceManager

public class L10nResourceManager

extends Object

The L10nResourceManager helps resolve resources (such as JSP pages, static resources such as HTML files, images etc.) based on a given locale.

Given a resource path in the form [dir]/[name] where [dir] is the directory ("/" separated, relative to the web app root) and [name] is the name of the resource, this class resolves the path to a localized version, if available.

For resolving a resource to a localized version, this class expects the locale to be present in the path structure as one of the sub-directory.

For instance, the following localized resources are considered valid for a resource "/portlets/news/flash.jsp":

• /en_US/portlets/news/flash.jsp
• /fr_FR/portlets/news/flash.jsp
• /portlets/en_US/news/flash.jsp
• /portlets/fr_FR/news/flash.jsp
• /portlets/news/en_US/flash.jsp
• /portlets/news/fr_FR/flash.jsp

This classes resolves for a localized version in the following search order:

• language_country_variant version
• language_country version
• language_variant version
• language version
• country_variant version
• country version
• Non-localized version

In order to enable this class to recognize newly added or deleted resources after server startup, enable hot deployment for classes via the WebLogic Server admin console.

Constructor Summary

protected

L10nResourceManager(ServletContext context) Constructs an instance of L10nResourceManager for the given context.

Method Summary

void	ensureReloaded() Make sure the cache is fresh.
static L10nResourceManager	getInstance(ServletContext context) Returns an instance of L10nResourceManager.
Enumeration	getPreferredLocales(ServletRequest request) Accessor for getting an Enumeration of preferred locales based on both the request and the setting of the internal localeProvider object, which is optionally overrideable by developers.
ArrayList	getPreferredLocalesAsList(ServletRequest request) Accessor for getting an ordered collection of preferred locales.
String	resolve(String path, Enumeration locales) Resolves the given path per the given locales to a localized resource.
String	resolve(String path, Enumeration locales, ResolvedLocale resolvedLocale) Version of resolve that accepts an out argument that is to be populated with extra resolution information
String	resolve(String path, ServletRequest request) Resolves the given path per the given locales to a localized resource.
String	resolve(String path, ServletRequest request, ResolvedLocale resolvedLocale) Version of resolve that accepts an out argument that is to be populated with extra resolution information

Methods inherited from class java.lang.Object

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

Constructor Detail

L10nResourceManager

protected L10nResourceManager(ServletContext context)

Constructs an instance of L10nResourceManager for the given context.

Parameters:

context - servlet context

Method Detail

getInstance

public static L10nResourceManager getInstance(ServletContext context)

Returns an instance of L10nResourceManager.

Parameters:

context - servlet context

Returns:

instance

ensureReloaded

public void ensureReloaded()

Make sure the cache is fresh.

getPreferredLocales

public Enumeration getPreferredLocales(ServletRequest request)

Accessor for getting an Enumeration of preferred locales based on both the request and the setting of the internal localeProvider object, which is optionally overrideable by developers.

Parameters:

request -

getPreferredLocalesAsList

public ArrayList getPreferredLocalesAsList(ServletRequest request)

Accessor for getting an ordered collection of preferred locales. Used in places where l10nManager cannot be used directly, but where a collection may be passed to a consumer of locales.

resolve

public String resolve(String path,
                      ServletRequest request)

Resolves the given path per the given locales to a localized resource. Applications may use this method to resolve resources such as JSP pages, or other static resources to locales.

Parameters:

path - path to the resource

request - current ServletRequest

Returns:

The localized path to the resource if present, otherwise returns the default path to the resource.

resolve

public String resolve(String path,
                      ServletRequest request,
                      ResolvedLocale resolvedLocale)

Version of resolve that accepts an out argument that is to be populated with extra resolution information

Parameters:

path -

request -

resolvedLocale -

resolve

public String resolve(String path,
                      Enumeration locales)

Resolves the given path per the given locales to a localized resource. Applications may use this method to resolve resources such as JSP pages, or other static resources to locales.

Parameters:

path - path to the resource

locales - preferred locales to use for resolution

Returns:

The localized path to the resource if present, otherwise returns the default path to the resource.

resolve

public String resolve(String path,
                      Enumeration locales,
                      ResolvedLocale resolvedLocale)

Version of resolve that accepts an out argument that is to be populated with extra resolution information

Parameters:

path -

locales -

resolvedLocale -