Package org.apache.struts2.interceptor.i18n

Class CookieLocaleHandler

java.lang.Object

org.apache.struts2.interceptor.i18n.AbstractLocaleHandler

org.apache.struts2.interceptor.i18n.RequestLocaleHandler

org.apache.struts2.interceptor.i18n.AcceptLanguageLocaleHandler

org.apache.struts2.interceptor.i18n.AbstractStoredLocaleHandler

org.apache.struts2.interceptor.i18n.CookieLocaleHandler

All Implemented Interfaces:

LocaleHandler

public abstract class CookieLocaleHandler
extends AbstractStoredLocaleHandler

Field Summary

Fields inherited from class org.apache.struts2.interceptor.i18n.AbstractLocaleHandler

actionInvocation

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CookieLocaleHandler(ActionInvocation invocation, String requestOnlyParameterName, Set<Locale> supportedLocale, String requestCookieParameterName, String attributeName)

Method Summary

Modifier and Type	Method	Description
Locale	find()	Looks for an explicit locale override in request-scoped sources.
Locale	read(ActionInvocation invocation)	Reads locale from persistent/context sources when LocaleHandler.find() did not resolve one.
Locale	store(ActionInvocation invocation, Locale locale)	Persists the resolved locale when storage is enabled for the current handler.

Methods inherited from class org.apache.struts2.interceptor.i18n.AbstractStoredLocaleHandler

findExplicitLocale, findRequestOnlyLocale, normalizeStoredLocale

Methods inherited from class org.apache.struts2.interceptor.i18n.AcceptLanguageLocaleHandler

findAcceptLanguageLocale

Methods inherited from class org.apache.struts2.interceptor.i18n.RequestLocaleHandler

findRequestOnlyParamLocale

Methods inherited from class org.apache.struts2.interceptor.i18n.AbstractLocaleHandler

disableStore, findLocaleParameter, getLocaleFromParam, isLocaleSupported, shouldStore

Methods inherited from class java.lang.Object

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

Constructor Details

CookieLocaleHandler

protected CookieLocaleHandler(ActionInvocation invocation,
 String requestOnlyParameterName,
 Set<Locale> supportedLocale,
 String requestCookieParameterName,
 String attributeName)

Method Details

find

public Locale find()

Description copied from interface: LocaleHandler

Looks for an explicit locale override in request-scoped sources.

Specified by:

find in interface LocaleHandler

Overrides:

find in class AcceptLanguageLocaleHandler

Returns:

a locale override or null when no explicit override is present

store

public Locale store(ActionInvocation invocation,
 Locale locale)

Description copied from interface: LocaleHandler

Persists the resolved locale when storage is enabled for the current handler.

Specified by:

store in interface LocaleHandler

Overrides:

store in class RequestLocaleHandler

Parameters:

invocation - current action invocation

locale - locale to store

Returns:

the effective locale to apply to the invocation context

read

public Locale read(ActionInvocation invocation)

Description copied from interface: LocaleHandler

Reads locale from persistent/context sources when LocaleHandler.find() did not resolve one.

Specified by:

read in interface LocaleHandler

Overrides:

read in class AcceptLanguageLocaleHandler

Parameters:

invocation - current action invocation

Returns:

resolved locale or null when no locale could be resolved