org.opencms.i18n
Class CmsLocaleManager

java.lang.Object
  org.opencms.i18n.CmsLocaleManager

All Implemented Interfaces:

I_CmsEventListener

public class CmsLocaleManager

extends Object

implements I_CmsEventListener

Manages the locales configured for this OpenCms installation.

Locale configuration is done in opencms.xml.

Since:

6.0.0

Version:

$Revision: 1.41 $

Author:

Carsten Weinholz, Alexander Kandzior

Field Summary

static String	LOCALE_HANDLER Runtime property name for locale handler.
static String	PARAMETER_ENCODING Request parameter to force encoding selection.
static String	PARAMETER_LOCALE Request parameter to force locale selection.

Fields inherited from interface org.opencms.main.I_CmsEventListener

EVENT_CLEAR_CACHES, EVENT_CLEAR_OFFLINE_CACHES, EVENT_CLEAR_ONLINE_CACHES, EVENT_FLEX_CACHE_CLEAR, EVENT_FLEX_PURGE_JSP_REPOSITORY, EVENT_LOGIN_USER, EVENT_PROJECT_MODIFIED, EVENT_PROPERTY_DEFINITION_CREATED, EVENT_PROPERTY_DEFINITION_MODIFIED, EVENT_PROPERTY_MODIFIED, EVENT_PUBLISH_PROJECT, EVENT_RESOURCE_AND_PROPERTIES_MODIFIED, EVENT_RESOURCE_COPIED, EVENT_RESOURCE_CREATED, EVENT_RESOURCE_DELETED, EVENT_RESOURCE_LIST_MODIFIED, EVENT_RESOURCE_MODIFIED, EVENT_RESOURCES_AND_PROPERTIES_MODIFIED, EVENT_RESOURCES_MODIFIED, EVENT_UPDATE_EXPORTS, KEY_CMSOBJECT, KEY_DBCONTEXT, KEY_PROJECTID, KEY_PUBLISHID, KEY_REPORT, LISTENERS_FOR_ALL_EVENTS

Constructor Summary

CmsLocaleManager()
Initializes a new CmsLocaleManager, called from the configuration.

CmsLocaleManager(Locale defaultLocale)
Initializes a new CmsLocaleManager, used for OpenCms runlevel 1 (unit tests) only.

Method Summary

void	addAvailableLocale(String localeName) Adds a locale to the list of available locales.
void	addDefaultLocale(String localeName) Adds a locale to the list of default locales.
void	cmsEvent(CmsEvent event) Implements the CmsEvent interface, the locale manager the events to clear the list of cached keys .
List	getAvailableLocales() Returns the list of available locales configured in.
List	getAvailableLocales(CmsObject cms, String resourceName) Returns an array of available locale names for the given resource.
List	getAvailableLocales(String names) Returns a List of available locales from a comma separated string of locale names.
Locale	getBestMatchingLocale(Locale requestedLocale, List locales, Collection filter) Returns the best matching locale from the given locales.
static Locale	getDefaultLocale() Returns the default locale configured in opencms.properties.
Locale	getDefaultLocale(CmsObject cms, String resourceName) Returns the "best" default locale for the given resource.
List	getDefaultLocales() Returns the list of default locale names configured in opencms.properties.
List	getDefaultLocales(CmsObject cms, String resourceName) Returns an array of default locales for the given resource.
Locale	getFirstMatchingLocale(List locales, Collection filter) Returns the first matching locale.
CmsI18nInfo	getI18nInfo(HttpServletRequest req, CmsUser user, CmsProject project, String resource) Returns the the appropriate locale/encoding for a request, using the "right" locale handler for the given resource.
static Locale	getLocale(String localeName) Returns a locale created from the given full name.
I_CmsLocaleHandler	getLocaleHandler() Returns the configured locale handler.
static List	getLocales(List localeNames) Returns a List of locales from an array of locale names.
static List	getLocales(String localeNames) Returns a List of locales from a comma-separated string of locale names.
void	initialize(CmsObject cms) Initializes this locale manager with the OpenCms system configuration.
boolean	isInitialized() Returns true if this locale manager is fully initialized.
void	setLocaleHandler(I_CmsLocaleHandler localeHandler) Sets the configured locale handler.

Methods inherited from class java.lang.Object

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

Field Detail

LOCALE_HANDLER

public static final String LOCALE_HANDLER

Runtime property name for locale handler.

See Also:

Constant Field Values

PARAMETER_ENCODING

public static final String PARAMETER_ENCODING

Request parameter to force encoding selection.

See Also:

Constant Field Values

PARAMETER_LOCALE

public static final String PARAMETER_LOCALE

Request parameter to force locale selection.

See Also:

Constant Field Values

Constructor Detail

CmsLocaleManager

public CmsLocaleManager()

Initializes a new CmsLocaleManager, called from the configuration.

CmsLocaleManager

public CmsLocaleManager(Locale defaultLocale)

Initializes a new CmsLocaleManager, used for OpenCms runlevel 1 (unit tests) only.

Parameters:

defaultLocale - the default locale to use

Method Detail

getDefaultLocale

public static Locale getDefaultLocale()

Returns the default locale configured in opencms.properties.

The default locale is the first locale int the list of configured default locales.

Returns:

the default locale

getLocale

public static Locale getLocale(String localeName)

Returns a locale created from the given full name.

The full name must consist of language code, country code(optional), variant(optional) separated by "_".

This method will always return a valid Locale! If the provided locale name is not valid (i.e. leads to an Exception when trying to create the Locale, then the configured default Locale is returned.

Parameters:

localeName - the full locale name

Returns:

the locale or null if not available

getLocales

public static List getLocales(List localeNames)

Returns a List of locales from an array of locale names.

Parameters:

localeNames - array of locale names

Returns:

a List of locales derived from the given locale names

getLocales

public static List getLocales(String localeNames)

Returns a List of locales from a comma-separated string of locale names.

Parameters:

localeNames - a comma-separated string of locale names

Returns:

a List of locales derived from the given locale names

addAvailableLocale

public void addAvailableLocale(String localeName)

Adds a locale to the list of available locales.

Parameters:

localeName - the locale to add

addDefaultLocale

public void addDefaultLocale(String localeName)

Adds a locale to the list of default locales.

Parameters:

localeName - the locale to add

cmsEvent

public void cmsEvent(CmsEvent event)

Implements the CmsEvent interface, the locale manager the events to clear the list of cached keys .

Specified by:

cmsEvent in interface I_CmsEventListener

Parameters:

event - CmsEvent that has occurred

getAvailableLocales

public List getAvailableLocales()

Returns the list of available locales configured in.

Returns:

the list of available locale names, e.g. en, de

getAvailableLocales

public List getAvailableLocales(CmsObject cms,
                                String resourceName)

Returns an array of available locale names for the given resource.

Parameters:

cms - the current cms permission object

resourceName - the name of the resource

Returns:

an array of available locale names

getAvailableLocales

public List getAvailableLocales(String names)

Returns a List of available locales from a comma separated string of locale names.

All names are filtered against the allowed available locales configured in opencms.properties.

Parameters:

names - a comma-separated String of locale names

Returns:

List of locales created from the given locale names

getBestMatchingLocale

public Locale getBestMatchingLocale(Locale requestedLocale,
                                    List locales,
                                    Collection filter)

Returns the best matching locale from the given locales.

The best matching locale is the first locale (eventually simplified) in the given list with the maximum number of parts similar to a (part of a) locale in the filter list. Example: getBestMatchingLocale([en_GB, de], {de, en, en_US} -> en since en_GB <> de = 0, en_GB <> en = 1, en_GB <> en_US = 1, de <> de = 1, de <> en = 0, de <> en_US = 0

Parameters:

requestedLocale - the originally requested locale

locales - a list of locale names

filter - a list of locale names to use as filter

Returns:

the best matching locale name or null if no name matches

getDefaultLocale

public Locale getDefaultLocale(CmsObject cms,
                               String resourceName)

Returns the "best" default locale for the given resource.

Parameters:

cms - the current cms permission object

resourceName - the name of the resource

Returns:

an array of default locale names

See Also:

getDefaultLocales(CmsObject, String)

getDefaultLocales

public List getDefaultLocales()

Returns the list of default locale names configured in opencms.properties.

Returns:

the list of default locale names, e.g. en, de

getDefaultLocales

public List getDefaultLocales(CmsObject cms,
                              String resourceName)

Returns an array of default locales for the given resource.

Use this method in case you need to get all available default options for a resource, if you just need the "best" default locale for a resource, use getDefaultLocale(CmsObject, String).

Parameters:

cms - the current cms permission object

resourceName - the name of the resource

Returns:

an array of default locale names

See Also:

getDefaultLocale(CmsObject, String)

getFirstMatchingLocale

public Locale getFirstMatchingLocale(List locales,
                                     Collection filter)

Returns the first matching locale.

Parameters:

locales - must be a ascending sourted list of locales in order of preference

filter - the filter to check the locales agains

Returns:

the first precise or simplified match

getI18nInfo

public CmsI18nInfo getI18nInfo(HttpServletRequest req,
                               CmsUser user,
                               CmsProject project,
                               String resource)

Returns the the appropriate locale/encoding for a request, using the "right" locale handler for the given resource.

Certain system folders (like the Workplace) require a special locale handler different from the configured handler. Use this method if you want to resolve locales exactly like the system does for a request.

Parameters:

req - the current http request

user - the current user

project - the current project

resource - the URI of the requested resource (with full site root added)

Returns:

the i18n information to use for the given request context

getLocaleHandler

public I_CmsLocaleHandler getLocaleHandler()

Returns the configured locale handler.

This handler is used to derive the appropriate locale/encoding for a request.

Returns:

the locale handler

initialize

public void initialize(CmsObject cms)

Initializes this locale manager with the OpenCms system configuration.

Parameters:

cms - an OpenCms context object that must have been initialized with "Admin" permissions

isInitialized

public boolean isInitialized()

Returns true if this locale manager is fully initialized.

This is required to prevent errors during unit tests, simple unit tests will usually not have a fully initialized locale manager available.

Returns:

true if the locale manager is fully initialized

setLocaleHandler

public void setLocaleHandler(I_CmsLocaleHandler localeHandler)

Sets the configured locale handler.

Parameters:

localeHandler - the locale handler to set