org.apache.sling.i18n

Interface RequestLocaleResolver

All Known Implementing Classes:

DefaultLocaleResolver

public interface RequestLocaleResolver

The RequestLocaleResolver service interface may be implemented by a service registered under this name to allow the resolution of the request Locale to apply.

This interface is intended to be implemented by providers knowing how to resolve one or more Locales applicable to handle the request.

Only a single RequestLocaleResolver service is currently used.

Since:

2.2

Method Summary

Modifier and Type	Method and Description
List<Locale>	resolveLocale(javax.servlet.http.HttpServletRequest request) Return a non-null but possibly empty list of Locale instances to consider for localization of the current request.

Method Detail

resolveLocale

List<Locale> resolveLocale(javax.servlet.http.HttpServletRequest request)

Return a non-null but possibly empty list of Locale instances to consider for localization of the current request. The list returned is assumed to be ordered by preference where the first entry is the preferred Locale and the last entry is the least preferred Locale.

Returning an empty list is equivalent to returning a singleton list whose single entry is the ResourceBundleProvider.getDefaultLocale().

Parameters:

request - The HttpServletRequest providing hints and information for the Locale resolution.

Returns:

The list of Locales to use for internationalization of request processing