Package org.opencms.i18n

Class CmsAcceptLanguageHeaderParser

java.lang.Object

org.opencms.i18n.CmsAcceptLanguageHeaderParser

public class CmsAcceptLanguageHeaderParser
extends Object

Parses the HTTP Accept-Language header as per section 14.4 of RFC 2068 (HTTP 1.1 header field definitions) and creates a sorted list of Locales from it.

Since:

6.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	CmsAcceptLanguageHeaderParser.AcceptLanguage	Struct representing an element of the HTTP Accept-Language header.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACCEPT_LANGUAGE	A constant for the HTTP Accept-Language header.
protected static final Float	DEFAULT_QUALITY	The default m_quality value for an AcceptLanguage object.

Constructor Summary

Constructors

Constructor	Description
CmsAcceptLanguageHeaderParser(String header, Locale defaultLocale)	Parses the Accept-Language header.
CmsAcceptLanguageHeaderParser(javax.servlet.http.HttpServletRequest req, Locale defaultLocale)	Parses the Accept-Language header from the provided request.

Method Summary

Modifier and Type	Method	Description
static String	createLanguageHeader()	Creates a value string for the HTTP Accept-Language header based on the default localed.
List<Locale>	getAcceptedLocales()	Returns the sorted list of accepted Locales.

Methods inherited from class java.lang.Object

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

Field Details

ACCEPT_LANGUAGE

public static final String ACCEPT_LANGUAGE

A constant for the HTTP Accept-Language header.

See Also:

• Constant Field Values

DEFAULT_QUALITY

protected static final Float DEFAULT_QUALITY

The default m_quality value for an AcceptLanguage object.

Constructor Details

CmsAcceptLanguageHeaderParser

public CmsAcceptLanguageHeaderParser(javax.servlet.http.HttpServletRequest req,
 Locale defaultLocale)

Parses the Accept-Language header from the provided request.

Parameters:

req - the request to parse

defaultLocale - the default locale to use

CmsAcceptLanguageHeaderParser

public CmsAcceptLanguageHeaderParser(String header,
 Locale defaultLocale)

Parses the Accept-Language header.

Parameters:

header - the Accept-Language header (i.e. en, es;q=0.8, zh-TW;q=0.1)

defaultLocale - the default locale to use

Method Details

createLanguageHeader

public static String createLanguageHeader()

Creates a value string for the HTTP Accept-Language header based on the default localed.

Returns:

value string for the HTTP Accept-Language

getAcceptedLocales

public List<Locale> getAcceptedLocales()

Returns the sorted list of accepted Locales.

Returns:

the sorted list of accepted Locales