Package org.opencms.i18n

Class CmsAcceptLanguageHeaderParser

  • public class CmsAcceptLanguageHeaderParser
extends java.lang.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

    • Field Summary

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

    • Constructor Summary

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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static java.lang.String createLanguageHeader()
      Creates a value string for the HTTP Accept-Language header based on the default localed.
      java.util.List<java.util.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 Detail

      • DEFAULT_QUALITY

        protected static final java.lang.Float DEFAULT_QUALITY
        The default m_quality value for an AcceptLanguage object.

    • Constructor Detail

      • CmsAcceptLanguageHeaderParser

        public CmsAcceptLanguageHeaderParser​(javax.servlet.http.HttpServletRequest req,
                                     java.util.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​(java.lang.String header,
                                     java.util.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 Detail

      • createLanguageHeader

        public static java.lang.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 java.util.List<java.util.Locale> getAcceptedLocales()
        Returns the sorted list of accepted Locales.

        Returns:
        the sorted list of accepted Locales