org.apache.struts2.interceptor

Class I18nInterceptor

java.lang.Object

com.opensymphony.xwork2.interceptor.AbstractInterceptor

org.apache.struts2.interceptor.I18nInterceptor

All Implemented Interfaces:

Interceptor, Serializable

public class I18nInterceptor
extends AbstractInterceptor

An interceptor that handles setting the locale specified in a session as the locale for the current action request. In addition, this interceptor will look for a specific HTTP request parameter and set the locale to whatever value is provided, it also looks for specific cookie to read locale from. This means that this interceptor can be used to allow for your application to dynamically change the locale for the user's session or, alternatively, only for the current request (since XWork 2.1.3). This is very useful for applications that require multi-lingual support and want the user to be able to set his or her language preference at any point. The locale parameter is removed during the execution of this interceptor, ensuring that properties aren't set on an action (such as request_locale) that have no typical corresponding setter in your action.

For example, using the default parameter name, a request to foo.action?request_locale=en_US, then the locale for US English is saved in the user's session and will be used for all future requests. If there is no locale set (for example with the first visit), the interceptor uses the browser locale.

• parameterName (optional) - the name of the HTTP request parameter that dictates the locale to switch to and save in the session. By default this is request_locale
• requestCookieParameterName (optional) - the name of the HTTP request parameter that dictates the locale to switch to and save in a cookie. By default this is request_cookie_locale
• requestOnlyParameterName (optional) - the name of the HTTP request parameter that dictates the locale to switch to for the current request only, without saving it in the session. By default this is request_only_locale
• attributeName (optional) - the name of the session key to store the selected locale. By default this is WW_TRANS_I18N_LOCALE
• storage (optional) - the name of storage location, it can be none, session or cookie. By default this is session

<interceptor name="i18nCookie" class="org.apache.struts2.interceptor.I18nInterceptor"/> <action name="someAction" class="com.examples.SomeAction"> <interceptor-ref name="i18nCookie"/> <interceptor-ref name="basicStack"/> <result name="success">good_result.ftl</result> </action>

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	I18nInterceptor.CookieLocaleHandler
protected static interface	I18nInterceptor.LocaleHandler Uses to handle reading/storing Locale from/in different locations
protected class	I18nInterceptor.RequestOnlyLocaleHandler
protected class	I18nInterceptor.SessionLocaleHandler
protected static class	I18nInterceptor.Storage

Field Summary

Fields

Modifier and Type	Field and Description
protected String	attributeName
static String	DEFAULT_COOKIE_ATTRIBUTE
static String	DEFAULT_COOKIE_PARAMETER
static String	DEFAULT_PARAMETER
static String	DEFAULT_REQUEST_ONLY_PARAMETER
static String	DEFAULT_SESSION_ATTRIBUTE
protected LocaleProvider	localeProvider
protected String	parameterName
protected String	requestCookieParameterName
protected String	requestOnlyParameterName
protected I18nInterceptor.Storage	storage

Constructor Summary

Constructors

Constructor and Description
I18nInterceptor()

Method Summary

Methods

Modifier and Type	Method and Description
protected Parameter	findLocaleParameter(ActionInvocation invocation, String parameterName)
protected Locale	getLocaleFromParam(Object requestedLocale) Creates a Locale object from the request param, which might be already a Local or a String
protected I18nInterceptor.LocaleHandler	getLocaleHandler(ActionInvocation invocation) Override this method to use your own implementation of I18nInterceptor.LocaleHandler
String	intercept(ActionInvocation invocation) Override to handle interception
void	setAttributeName(String attributeName)
void	setLocaleProvider(LocaleProvider localeProvider)
void	setLocaleStorage(String storageName)
void	setParameterName(String parameterName)
void	setRequestCookieParameterName(String requestCookieParameterName)
void	setRequestOnlyParameterName(String requestOnlyParameterName)
protected void	useLocale(ActionInvocation invocation, Locale locale) Save the given locale to the ActionInvocation.

Methods inherited from class com.opensymphony.xwork2.interceptor.AbstractInterceptor

destroy, init

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SESSION_ATTRIBUTE

public static final String DEFAULT_SESSION_ATTRIBUTE

See Also:

Constant Field Values

DEFAULT_PARAMETER

public static final String DEFAULT_PARAMETER

See Also:

Constant Field Values

DEFAULT_REQUEST_ONLY_PARAMETER

public static final String DEFAULT_REQUEST_ONLY_PARAMETER

See Also:

Constant Field Values

DEFAULT_COOKIE_ATTRIBUTE

public static final String DEFAULT_COOKIE_ATTRIBUTE

See Also:

Constant Field Values

DEFAULT_COOKIE_PARAMETER

public static final String DEFAULT_COOKIE_PARAMETER

See Also:

Constant Field Values

parameterName

protected String parameterName

requestOnlyParameterName

protected String requestOnlyParameterName

attributeName

protected String attributeName

requestCookieParameterName

protected String requestCookieParameterName

storage

protected I18nInterceptor.Storage storage

localeProvider

protected LocaleProvider localeProvider

Constructor Detail

I18nInterceptor

public I18nInterceptor()

Method Detail

setParameterName

public void setParameterName(String parameterName)

setAttributeName

public void setAttributeName(String attributeName)

setRequestOnlyParameterName

public void setRequestOnlyParameterName(String requestOnlyParameterName)

setRequestCookieParameterName

public void setRequestCookieParameterName(String requestCookieParameterName)

setLocaleStorage

public void setLocaleStorage(String storageName)

setLocaleProvider

public void setLocaleProvider(LocaleProvider localeProvider)

intercept

public String intercept(ActionInvocation invocation)
                 throws Exception

Description copied from class: AbstractInterceptor

Override to handle interception

Specified by:

intercept in interface Interceptor

Specified by:

intercept in class AbstractInterceptor

Parameters:

invocation - the action invocation

Returns:

the return code, either returned from ActionInvocation.invoke(), or from the interceptor itself.

Throws:

Exception - any system-level error, as defined in Action.execute().

getLocaleHandler

protected I18nInterceptor.LocaleHandler getLocaleHandler(ActionInvocation invocation)

Override this method to use your own implementation of I18nInterceptor.LocaleHandler

Parameters:

invocation - current action invocation context

Returns:

instance of I18nInterceptor.LocaleHandler

getLocaleFromParam

protected Locale getLocaleFromParam(Object requestedLocale)

Creates a Locale object from the request param, which might be already a Local or a String

Parameters:

requestedLocale - the parameter from the request

Returns:

the Locale

findLocaleParameter

protected Parameter findLocaleParameter(ActionInvocation invocation,
                            String parameterName)

useLocale

protected void useLocale(ActionInvocation invocation,
             Locale locale)

Save the given locale to the ActionInvocation.

Parameters:

invocation - The ActionInvocation.

locale - The locale to save.