Package org.opencms.i18n

Interface I_CmsLocaleHandler

All Known Implementing Classes:
CmsDefaultLocaleHandler, CmsSingleTreeLocaleHandler, CmsWorkplaceManager
public interface I_CmsLocaleHandler
A locale handler returns the locale name to use for the given request context.

By implementing this interface, and configuring OpenCms accordingly, the behaviour for the m_locale selection can be fine-tuned to the exact need of the OpenCms installation.

Since:
6.0.0

  • Method Summary

    Modifier and Type
    Method
    Description
    CmsI18nInfo
    getI18nInfo(jakarta.servlet.http.HttpServletRequest req, CmsUser user, CmsProject project, String resource)
    Returns the i18n information to use in the request context.
    void
    initHandler(CmsObject cms)
    Will be called during system startup.

  • Method Details

    • getI18nInfo

      CmsI18nInfo getI18nInfo(jakarta.servlet.http.HttpServletRequest req, CmsUser user, CmsProject project, String resource)
      Returns the i18n information to use in the request context.

      Parameters:
      req - the current http request
      user - the current user
      project - the current project
      resource - the URI of the requested resource (with full site root added)
      Returns:
      the i18n information to use for the given request context

    • initHandler

      void initHandler(CmsObject cms)
      Will be called during system startup.

      Parameters:
      cms - an initialized cms permission context for VFS access