Package org.apache.struts.extras.actions

Class LocaleAction

java.lang.Object

org.apache.struts.action.Action

org.apache.struts.extras.actions.BaseAction

org.apache.struts.extras.actions.LocaleAction

All Implemented Interfaces:

Serializable

public final class LocaleAction
extends BaseAction

Implementation of Action that changes the user's Locale and forwards to a page, based on request level parameters that are set (language, country, & page).

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.apache.struts.extras.actions.BaseAction

messages

Fields inherited from class org.apache.struts.action.Action

ERROR, INPUT, LOGIN, servlet, SUCCESS

Constructor Summary

Constructors

Constructor	Description
LocaleAction()

Method Summary

Modifier and Type	Method	Description
ActionForward	execute(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response)	Change the user's Locale based on ActionForm properties.

Methods inherited from class org.apache.struts.action.Action

addErrors, addMessages, execute, generateToken, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, saveErrors, saveErrors, saveMessages, saveMessages, saveToken, setLocale, setServlet

Methods inherited from class java.lang.Object

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

Constructor Details

LocaleAction

public LocaleAction()

Method Details

execute

public ActionForward execute(ActionMapping mapping,
 ActionForm form,
 HttpServletRequest request,
 HttpServletResponse response)
                      throws Exception

Change the user's Locale based on ActionForm properties.

This Action looks for language and country properties on the given form, constructs an appropriate Locale object, and sets it as the Struts Locale for this user's session. Any ActionForm, including a DynaActionForm, may be used.

If a page property is also provided, then after setting the Locale, control is forwarded to that URI path. Otherwise, control is forwarded to "success".

Overrides:

execute in class Action

Parameters:

mapping - The ActionMapping used to select this instance

form - The optional ActionForm bean for this request (if any)

request - The HTTP request we are processing

response - The HTTP response we are creating

Returns:

Action to forward to

Throws:

Exception - if an input/output error or servlet exception occurs