org.opencms.i18n
Class CmsLocaleManager

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

All Implemented Interfaces:

I_CmsEventListener

public class CmsLocaleManager
extends java.lang.Object
implements I_CmsEventListener

Manages the locales configured for this OpenCms installation.

Locale configuration is done in the configuration file opencms-system.xml in the opencms/system/internationalization node and it's sub-nodes.

Since:

6.0.0

Version:

$Revision: 1.61 $

Author:

Carsten Weinholz, Alexander Kandzior

Field Summary

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

Fields inherited from interface org.opencms.main.I_CmsEventListener

EVENT_BEFORE_PUBLISH_PROJECT, EVENT_CLEAR_CACHES, EVENT_CLEAR_OFFLINE_CACHES, EVENT_CLEAR_ONLINE_CACHES, EVENT_CLEAR_PRINCIPAL_CACHES, EVENT_FLEX_CACHE_CLEAR, EVENT_FLEX_PURGE_JSP_REPOSITORY, EVENT_FULLSTATIC_EXPORT, EVENT_GROUP_MODIFIED, EVENT_LOGIN_USER, EVENT_OU_MODIFIED, EVENT_PROJECT_MODIFIED, EVENT_PROPERTY_DEFINITION_CREATED, EVENT_PROPERTY_DEFINITION_MODIFIED, EVENT_PROPERTY_MODIFIED, EVENT_PUBLISH_PROJECT, EVENT_REBUILD_SEARCHINDEXES, EVENT_RESOURCE_AND_PROPERTIES_MODIFIED, EVENT_RESOURCE_COPIED, EVENT_RESOURCE_CREATED, EVENT_RESOURCE_DELETED, EVENT_RESOURCE_MODIFIED, EVENT_RESOURCE_MOVED, EVENT_RESOURCES_AND_PROPERTIES_MODIFIED, EVENT_RESOURCES_MODIFIED, EVENT_UPDATE_EXPORTS, EVENT_USER_MODIFIED, KEY_CHANGE, KEY_DBCONTEXT, KEY_GROUP_ID, KEY_GROUP_NAME, KEY_INDEX_NAMES, KEY_OU_ID, KEY_OU_NAME, KEY_PROJECTID, KEY_PUBLISHID, KEY_PUBLISHLIST, KEY_REPORT, KEY_RESOURCE, KEY_RESOURCES, KEY_USER_ACTION, KEY_USER_ID, KEY_USER_NAME, LISTENERS_FOR_ALL_EVENTS, VALUE_GROUP_MODIFIED_ACTION_CREATE, VALUE_GROUP_MODIFIED_ACTION_DELETE, VALUE_GROUP_MODIFIED_ACTION_WRITE, VALUE_OU_MODIFIED_ACTION_CREATE, VALUE_OU_MODIFIED_ACTION_DELETE, VALUE_USER_MODIFIED_ACTION_ADD_USER_TO_GROUP, VALUE_USER_MODIFIED_ACTION_CREATE_USER, VALUE_USER_MODIFIED_ACTION_DELETE_USER, VALUE_USER_MODIFIED_ACTION_REMOVE_USER_FROM_GROUP, VALUE_USER_MODIFIED_ACTION_RESET_PASSWORD, VALUE_USER_MODIFIED_ACTION_SET_OU, VALUE_USER_MODIFIED_ACTION_WRITE_USER

Constructor Summary

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

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

Method Summary

void	addAvailableLocale(java.lang.String localeName) Adds a locale to the list of available locales.
void	addDefaultLocale(java.lang.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 .
java.util.List<java.util.Locale>	getAvailableLocales() Returns the list of available Locales configured in opencms-system.xml, in the opencms/system/internationalization/localesconfigured node.
java.util.List<java.util.Locale>	getAvailableLocales(CmsObject cms, java.lang.String resourceName) Returns an array of available locale names for the given resource.
java.util.List<java.util.Locale>	getAvailableLocales(java.lang.String names) Returns a List of available locales from a comma separated string of locale names.
java.util.Locale	getBestMatchingLocale(java.util.Locale requestedLocale, java.util.List<java.util.Locale> defaults, java.util.Collection<java.util.Locale> available) Tries to find the given requested locale (eventually simplified) in the collection of available locales, if the requested locale is not found it will return the first match from the given list of default locales.
static java.util.Locale	getDefaultLocale() Returns the default locale configured in opencms-system.xml, that is the first locale from the list provided in the opencms/system/internationalization/localesdefault node.
java.util.Locale	getDefaultLocale(CmsObject cms, java.lang.String resourceName) Returns the "the" default locale for the given resource.
java.util.List<java.util.Locale>	getDefaultLocales() Returns the list of default Locales configured in opencms-system.xml, in the opencms/system/internationalization/localesdefault node.
java.util.List<java.util.Locale>	getDefaultLocales(CmsObject cms, CmsResource resource) Returns an array of default locales for the given resource.
java.util.List<java.util.Locale>	getDefaultLocales(CmsObject cms, java.lang.String resourceName) Returns an array of default locales for the given resource.
java.util.Locale	getFirstMatchingLocale(java.util.List<java.util.Locale> locales, java.util.Collection<java.util.Locale> available) Returns the first matching locale (eventually simplified) from the available locales.
CmsI18nInfo	getI18nInfo(javax.servlet.http.HttpServletRequest req, CmsUser user, CmsProject project, java.lang.String resource) Returns the the appropriate locale/encoding for a request, using the "right" locale handler for the given resource.
static java.util.Locale	getLocale(java.lang.String localeName) Returns a locale created from the given full name.
I_CmsLocaleHandler	getLocaleHandler() Returns the configured locale handler.
static java.lang.String	getLocaleNames(java.util.List<java.util.Locale> locales) Returns the locale names from the given List of locales as a comma separated String.
static java.util.List<java.util.Locale>	getLocales(java.util.List<java.lang.String> localeNames) Returns a List of locales from an array of locale names.
static java.util.List<java.util.Locale>	getLocales(java.lang.String localeNames) Returns a List of locales from a comma-separated string of locale names.
static java.lang.String	getResourceEncoding(CmsObject cms, CmsResource res) Returns the content encoding set for the given resource.
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 java.lang.String LOCALE_HANDLER

Runtime property name for locale handler.

See Also:

Constant Field Values

PARAMETER_ENCODING

public static final java.lang.String PARAMETER_ENCODING

Request parameter to force encoding selection.

See Also:

Constant Field Values

PARAMETER_LOCALE

public static final java.lang.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(java.util.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 java.util.Locale getDefaultLocale()

Returns the default locale configured in opencms-system.xml, that is the first locale from the list provided in the opencms/system/internationalization/localesdefault node.

Returns:

the default locale configured in opencms-system.xml

getLocale

public static java.util.Locale getLocale(java.lang.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

getLocaleNames

public static java.lang.String getLocaleNames(java.util.List<java.util.Locale> locales)

Returns the locale names from the given List of locales as a comma separated String.

For example, if the input List contains Locale.ENGLISH and Locale.GERMANY, the result will be "en, de_DE".

An empty String is returned if the input is null, or contains no elements.

Parameters:

locales - the locales to generate a String from

Returns:

the locale names from the given List of locales as a comma separated String

getLocales

public static java.util.List<java.util.Locale> getLocales(java.util.List<java.lang.String> 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 java.util.List<java.util.Locale> getLocales(java.lang.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

getResourceEncoding

public static final java.lang.String getResourceEncoding(CmsObject cms,
                                                         CmsResource res)

Returns the content encoding set for the given resource.

The content encoding is controlled by the property CmsPropertyDefinition.PROPERTY_CONTENT_ENCODING, which can be set on the resource or on a parent folder for all resources in this folder.

In case no encoding has been set, the default encoding from CmsSystemInfo.getDefaultEncoding() is returned.

Parameters:

cms - the current OpenCms user context

res - the resource to read the encoding for

Returns:

the content encoding set for the given resource

addAvailableLocale

public void addAvailableLocale(java.lang.String localeName)

Adds a locale to the list of available locales.

Parameters:

localeName - the locale to add

addDefaultLocale

public void addDefaultLocale(java.lang.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 java.util.List<java.util.Locale> getAvailableLocales()

Returns the list of available Locales configured in opencms-system.xml, in the opencms/system/internationalization/localesconfigured node.

The list of configured available locales contains all locales that are allowed to be used in the VFS, for example as languages in XML content files.

The available locales are a superset of the default locales, see getDefaultLocales().

It's possible to reduce the system default by setting the propery CmsPropertyDefinition.PROPERTY_AVAILABLE_LOCALES to a comma separated list of locale names. However, you can not add new available locales, only remove from the configured list.

Returns:

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

See Also:

getDefaultLocales()

getAvailableLocales

public java.util.List<java.util.Locale> getAvailableLocales(CmsObject cms,
                                                            java.lang.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

See Also:

getAvailableLocales()

getAvailableLocales

public java.util.List<java.util.Locale> getAvailableLocales(java.lang.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-system.xml.

Parameters:

names - a comma-separated String of locale names

Returns:

List of locales created from the given locale names

See Also:

getAvailableLocales()

getBestMatchingLocale

public java.util.Locale getBestMatchingLocale(java.util.Locale requestedLocale,
                                              java.util.List<java.util.Locale> defaults,
                                              java.util.Collection<java.util.Locale> available)

Tries to find the given requested locale (eventually simplified) in the collection of available locales, if the requested locale is not found it will return the first match from the given list of default locales.

Parameters:

requestedLocale - the requested locale, if this (or a simplified version of it) is available it will be returned

defaults - a list of default locales to use in case the requested locale is not available

available - the available locales to find a match in

Returns:

the best matching locale name or null if no name matches

getDefaultLocale

public java.util.Locale getDefaultLocale(CmsObject cms,
                                         java.lang.String resourceName)

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

It's possible to override the system default (see getDefaultLocale()) by setting the property CmsPropertyDefinition.PROPERTY_LOCALE to a comma separated list of locale names. This property is inherited from the parent folders. This method will return the first locale from that list.

The default locale must be contained in the set of configured available locales, see getAvailableLocales(). In case an invalid locale has been set with the property, this locale is ignored and the same result as getDefaultLocale() is returned.

In case the property CmsPropertyDefinition.PROPERTY_LOCALE has not been set on the resource or a parent folder, this method returns the same result as getDefaultLocale().

Parameters:

cms - the current cms permission object

resourceName - the name of the resource

Returns:

an array of default locale names

See Also:

getDefaultLocales(), getDefaultLocales(CmsObject, String)

getDefaultLocales

public java.util.List<java.util.Locale> getDefaultLocales()

Returns the list of default Locales configured in opencms-system.xml, in the opencms/system/internationalization/localesdefault node.

Since the default locale is always available, the result list will always contain at least one Locale.

It's possible to override the system default by setting the property CmsPropertyDefinition.PROPERTY_LOCALE to a comma separated list of locale names. This property is inherited from the parent folders.

The default locales must be a subset of the configured available locales, see getAvailableLocales(). In case an invalid locale has been set with the property, this locale is ignored.

The default locale names are used as a fallback mechanism in case a locale is requested that can not be found, for example when delivering content form an XML content.

There is a list of default locales (instead of just one default locale) since there are scenarios when one default is not enough. Consider the following example: The main default locale is set to "en". An example XML content file contains just one language, in this case "de" and not "en". Now a request is made to the file for the locale "fr". If there would be only one default locale ("en"), we would have to give up. But since we allow more then one default, we can deliver the "de" content instead of a blank page.

Returns:

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

See Also:

getAvailableLocales()

getDefaultLocales

public java.util.List<java.util.Locale> getDefaultLocales(CmsObject cms,
                                                          CmsResource resource)

Returns an array of default locales for the given resource.

Since the default locale is always available, the result list will always contain at least one Locale.

It's possible to override the system default (see getDefaultLocales()) by setting the property CmsPropertyDefinition.PROPERTY_LOCALE to a comma separated list of locale names. This property is inherited from the parent folders.

The default locales must be a subset of the configured available locales, see getAvailableLocales(). In case an invalid locale has been set with the property, this locale is ignored.

In case the property CmsPropertyDefinition.PROPERTY_LOCALE has not been set on the resource or a parent folder, this method returns the same result as getDefaultLocales().

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

Parameters:

cms - the current cms permission object

resource - the resource to read the default locale properties for

Returns:

an array of default locale names

Since:

7.0.2

See Also:

getDefaultLocales(), getDefaultLocale(CmsObject, String), getDefaultLocales(CmsObject, String)

getDefaultLocales

public java.util.List<java.util.Locale> getDefaultLocales(CmsObject cms,
                                                          java.lang.String resourceName)

Returns an array of default locales for the given resource.

Since the default locale is always available, the result list will always contain at least one Locale.

It's possible to override the system default (see getDefaultLocales()) by setting the property CmsPropertyDefinition.PROPERTY_LOCALE to a comma separated list of locale names. This property is inherited from the parent folders.

The default locales must be a subset of the configured available locales, see getAvailableLocales(). In case an invalid locale has been set with the property, this locale is ignored.

In case the property CmsPropertyDefinition.PROPERTY_LOCALE has not been set on the resource or a parent folder, this method returns the same result as getDefaultLocales().

Use this method in case you need to get all configured default options for a resource, if you just need the "the" 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:

getDefaultLocales(), getDefaultLocale(CmsObject, String), getDefaultLocales(CmsObject, CmsResource)

getFirstMatchingLocale

public java.util.Locale getFirstMatchingLocale(java.util.List<java.util.Locale> locales,
                                               java.util.Collection<java.util.Locale> available)

Returns the first matching locale (eventually simplified) from the available locales.

In case no match is found, code null is returned.

Parameters:

locales - must be an ascending sorted list of locales in order of preference

available - the available locales to find a match in

Returns:

the first precise or simplified match, or null in case no match is found

getI18nInfo

public CmsI18nInfo getI18nInfo(javax.servlet.http.HttpServletRequest req,
                               CmsUser user,
                               CmsProject project,
                               java.lang.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