Package org.apereo.cas.configuration.model.core.web

Class LocaleProperties

java.lang.Object

org.apereo.cas.configuration.model.core.web.LocaleProperties

All Implemented Interfaces:

Serializable

@RequiresModule(name="cas-server-core-web",
                automated=true)
public class LocaleProperties
extends Object
implements Serializable

Configuration properties class for locale.

Since:

5.0.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
LocaleProperties()

Method Summary

Modifier and Type	Method	Description
LocaleCookieProperties	getCookie()	Control the properties of the cookie created to hold language changes.
String	getDefaultValue()	Default locale.
String	getParamName()	Parameter name to use when switching locales.
boolean	isForceDefaultLocale()	When set to true, locale resolution via request parameters and such is ignored and the locale default value is always enforced.
LocaleProperties	setCookie(LocaleCookieProperties cookie)	Control the properties of the cookie created to hold language changes.
LocaleProperties	setDefaultValue(String defaultValue)	Default locale.
LocaleProperties	setForceDefaultLocale(boolean forceDefaultLocale)	When set to true, locale resolution via request parameters and such is ignored and the locale default value is always enforced.
LocaleProperties	setParamName(String paramName)	Parameter name to use when switching locales.

Methods inherited from class java.lang.Object

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

Constructor Details

LocaleProperties

public LocaleProperties()

Method Details

getParamName

public String getParamName()

Parameter name to use when switching locales.

getDefaultValue

public String getDefaultValue()

Default locale.

isForceDefaultLocale

public boolean isForceDefaultLocale()

When set to true, locale resolution via request parameters and such is ignored and the locale default value is always enforced.

getCookie

public LocaleCookieProperties getCookie()

Control the properties of the cookie created to hold language changes.

setParamName

public LocaleProperties setParamName(String paramName)

Parameter name to use when switching locales.

Returns:

this.

setDefaultValue

public LocaleProperties setDefaultValue(String defaultValue)

Default locale.

Returns:

this.

setForceDefaultLocale

public LocaleProperties setForceDefaultLocale(boolean forceDefaultLocale)

When set to true, locale resolution via request parameters and such is ignored and the locale default value is always enforced.

Returns:

this.

setCookie

public LocaleProperties setCookie(LocaleCookieProperties cookie)

Control the properties of the cookie created to hold language changes.

Returns:

this.