org.apache.cocoon.acting
Class LocaleAction

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.acting.AbstractAction
          org.apache.cocoon.acting.ServiceableAction
              org.apache.cocoon.acting.LocaleAction

All Implemented Interfaces:

Component, Configurable, LogEnabled, Serviceable, ThreadSafe, Action

public class LocaleAction
extends ServiceableAction
implements ThreadSafe, Configurable

An action that locates and provides to the pipeline locale information looked up in a range of ways.

Configuration

A sample configuration (given in the <map:matchers> section of the sitemap) is given below. This configuration shows default values.

   <map:action name="locale" src="org.apache.cocoon.acting.LocaleAction">
     <locale-attribute>locale</locale-attribute>
     <use-locale>true</use-locale>
     <default-locale language="en" country="US"/>
     <store-in-request>false<store-in-request>
     <create-session>false<create-session>
     <store-in-session>false<store-in-session>
     <store-in-cookie>false<store-in-cookie>
   </map:action>
 

Above configuration parameters mean:

• locale-attribute specifies the name of the request parameter / session attribute / cookie that is to be used as a locale (defaults to locale)
• use-locale specifies whether the primary locale provided by the user agent (or server default, is no locale passed by the agent) is to be used
• default-locale specifies the default locale to be used when none found.
• store-in-request specifies whether found locale should be stored as request attribute.
• create-session specifies whether session should be created when storing found locale as session attribute.
• store-in-session specifies whether found locale should be stored as session attribute.
• store-in-cookie specifies whether found locale should be stored as cookie.

Usage

This action will be used in a pipeline like so:

   <map:act type="locale">
     <map:generate src="file_{language}_{country}_{variant}.xml"/>
     ...
   </map:match>
 

or

   <map:act type="locale">
     <map:generate src="file_{locale}.xml"/>
     ...
   </map:match>
 

Locale Identification

Locales will be tested in following order:

• Locale provided as a request parameter
• Locale provided as a session attribute
• Locale provided as a cookie
• Locale provided using a sitemap parameter
  (<map:parameter name="locale" value="{1}"/> style parameter within the <map:match> node)
• Locale provided by the user agent, or server default, if use-locale is set to true
• The default locale, if specified in the matcher's configuration

First found locale will be returned.

Sitemap Variables

Once locale has been found, the following sitemap variables will be available to sitemap elements contained within the action:

• {locale}: The locale string
• {language}: The language of the found locale
• {country}: The country of the found locale
• {variant}: The variant of the found locale

Version:

CVS $Id: LocaleAction.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Marcus Crafter, Konstantin Piroumian, Lassi Immonen, Vadim Gritsenko

Field Summary

static String	CREATE_SESSION Constant representing the session creation configuration attribute
static String	LOCALE Default locale attribute name.
static String	LOCALE_ATTR Configuration element name for locale attribute name.
static String	STORE_COOKIE Constant representing the cookie storage configuration attribute
static String	STORE_REQUEST Constant representing the request storage configuration attribute
static String	STORE_SESSION Constant representing the session storage configuration attribute

Fields inherited from class org.apache.cocoon.acting.ServiceableAction

manager

Fields inherited from class org.apache.cocoon.acting.AbstractAction

EMPTY_MAP

Fields inherited from interface org.apache.cocoon.acting.Action

ROLE

Constructor Summary

LocaleAction()

Method Summary

Map	act(Redirector redirector, SourceResolver resolver, Map objectModel, String source, Parameters params) Action which obtains the current environments locale information, and places it in the objectModel (and optionally in a session/cookie).
void	configure(Configuration config) Configure this action.
static String	getLocaleAttribute(Map objectModel, String localeAttrName) Deprecated. See I18nUtils.findLocale

Methods inherited from class org.apache.cocoon.acting.ServiceableAction

service

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 Detail

LOCALE

public static final String LOCALE

Default locale attribute name.

See Also:

Constant Field Values

LOCALE_ATTR

public static final String LOCALE_ATTR

Configuration element name for locale attribute name.

See Also:

Constant Field Values

STORE_REQUEST

public static final String STORE_REQUEST

Constant representing the request storage configuration attribute

See Also:

Constant Field Values

CREATE_SESSION

public static final String CREATE_SESSION

Constant representing the session creation configuration attribute

See Also:

Constant Field Values

STORE_SESSION

public static final String STORE_SESSION

Constant representing the session storage configuration attribute

See Also:

Constant Field Values

STORE_COOKIE

public static final String STORE_COOKIE

Constant representing the cookie storage configuration attribute

See Also:

Constant Field Values

Constructor Detail

LocaleAction

public LocaleAction()

Method Detail

configure

public void configure(Configuration config)
               throws ConfigurationException

Configure this action.

Specified by:

configure in interface Configurable

Parameters:

config - configuration information (if any)

Throws:

ConfigurationException

act

public Map act(Redirector redirector,
               SourceResolver resolver,
               Map objectModel,
               String source,
               Parameters params)
        throws Exception

Action which obtains the current environments locale information, and places it in the objectModel (and optionally in a session/cookie).

Specified by:

act in interface Action

resolver - The SourceResolver in charge

objectModel - The Map with object of the calling environment which can be used to select values this controller may need (ie Request, Response).

source - A source String to the Action

params - The Parameters for this invocation

Returns:

Map The returned Map object with sitemap substitution values which can be used in subsequent elements attributes like src= using a xpath like expression: src="mydir/{myval}/foo" If the return value is null the processing inside the element of the sitemap will be skipped.

Throws:

Exception - Indicates something is totally wrong

getLocaleAttribute

public static String getLocaleAttribute(Map objectModel,
                                        String localeAttrName)

Deprecated. See I18nUtils.findLocale

Helper method to retreive the attribute value containing locale information. See class documentation for locale determination algorythm.

Parameters:

objectModel - requesting object's environment

Returns:

locale value or null if no locale was found