Package org.ametys.core.util.language

Class LocaleHelper

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.core.util.language.LocaleHelper

All Implemented Interfaces:

DeferredServiceable, Component, LogEnabled

public class LocaleHelper
extends AbstractLogEnabled
implements Component, DeferredServiceable

Retrieve the language to use in interface from the current user preferences, the configuration parameters or the browser.

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected UserLanguagesManager	_userLanguagesManager	The current user provider
protected UserManager	_userManager	The current user provider
static final String	ROLE	The component role

Constructor Summary

Constructors

Constructor	Description
LocaleHelper()

Method Summary

Modifier and Type	Method	Description
void	deferredService(ServiceManager manager)	Pass the ServiceManager used to access other components.
protected Locale	findCurrentUserLocale()	Retrieve the locale from the current user
Locale	findLocale(Map objectModel)	Find the locale to use in interface.

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

The component role

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

_userManager

protected UserManager _userManager

The current user provider

_userLanguagesManager

protected UserLanguagesManager _userLanguagesManager

The current user provider

Constructor Details

LocaleHelper

public LocaleHelper()

Method Details

deferredService

public void deferredService(ServiceManager manager)
                     throws ServiceException

Description copied from interface: DeferredServiceable

Pass the ServiceManager used to access other components.

Specified by:

deferredService in interface DeferredServiceable

Parameters:

manager - The ServiceManager which this DeferredServiceable uses. Must not be null.

Throws:

ServiceException - if an error occurs

findLocale

public Locale findLocale(Map objectModel)

Find the locale to use in interface.

Parameters:

objectModel - The object model to retrieve the default locale from browser if not found in user preferences or configuration parameters

Returns:

The locale to use, first try from user preferences, then from request, then from configuration parameters and then from I18nUtils.findLocale (server locale), null if no locale was found

findCurrentUserLocale

protected Locale findCurrentUserLocale()

Retrieve the locale from the current user

Returns:

The locale from the current user or none if no user found or no language found for the user