Package org.exoplatform.services.resources

Class LocaleContextInfo

java.lang.Object
org.exoplatform.services.resources.LocaleContextInfo
public class LocaleContextInfo extends Object
Data structure that holds the inputs for LocalePolicy pluggable policies mechanism.
Author:
Marko Strukelj

  • Constructor Details

    • LocaleContextInfo

      public LocaleContextInfo()

  • Method Details

    • setSupportedLocales

      public void setSupportedLocales(Set<Locale> supportedLocales)
      Setter for supportedLocales
      Parameters:
      supportedLocales - locales supported by portal

    • getSupportedLocales

      public Set<Locale> getSupportedLocales()
      Getter for supportedLocales
      Returns:
      supportedLocales

    • setBrowserLocales

      public void setBrowserLocales(List<Locale> browserLocales)
      Setter for browserLocales
      Parameters:
      browserLocales - list of locales as preferred by client's browser

    • getBrowserLocales

      public List<Locale> getBrowserLocales()
      Getter for browserLocales
      Returns:
      browserLocales

    • setCookieLocales

      public void setCookieLocales(List<Locale> cookieLocales)
      Setter for cookieLocales
      Parameters:
      cookieLocales - locales stored in user's browser cookie

    • getCookieLocales

      public List<Locale> getCookieLocales()
      Getter for cookieLocales
      Returns:
      cookieLocales

    • setUserProfileLocale

      public void setUserProfileLocale(Locale userProfileLocale)
      Setter for userProfileLocale
      Parameters:
      userProfileLocale - locale loaded from user's profile

    • getUserProfileLocale

      public Locale getUserProfileLocale()
      Getter for userProfileLocale
      Returns:
      userProfileLocale

    • setRemoteUser

      public void setRemoteUser(String remoteUser)
      Setter for remoteUser
      Parameters:
      remoteUser - username of the currently logged in user. Null for anonymous users.

    • getRemoteUser

      public String getRemoteUser()
      Getter for remoteUser
      Returns:
      remoteUser

    • setPortalLocale

      public void setPortalLocale(Locale portalLocale)
      Setter for portalLocale
      Parameters:
      portalLocale - default locale configured for the portal

    • getPortalLocale

      public Locale getPortalLocale()
      Getter for portalLocale
      Returns:
      portalLocale

    • setSessionLocale

      public void setSessionLocale(Locale locale)
      Setter for sessionLocale
      Parameters:
      locale - Locale stored in current session

    • getSessionLocale

      public Locale getSessionLocale()
      Getter for sessionLocale
      Returns:
      sessionLocale

    • getRequestLocale

      public Locale getRequestLocale()
      Getter for requestLocale
      Returns:
      requestLocale

    • setRequestLocale

      public void setRequestLocale(Locale requestLocale)
      Setter for requestLocale
      Parameters:
      requestLocale - default locale configured for the request

    • getLocaleIfSupported

      public Locale getLocaleIfSupported(Locale locale)
      Helper method that returns the locale only if it's supported by portal. Otherwise it returns null.
      Parameters:
      locale - locale to check
      Returns:
      original locale if supported, null otherwise

    • getLocaleIfLangSupported

      public Locale getLocaleIfLangSupported(Locale locale)
      Helper method that returns the locale only if it's language is supported by portal. Otherwise it returns null.
      Parameters:
      locale - locale to check
      Returns:
      original locale if language is supported, null otherwise

    • getLocale

      public static Locale getLocale(String portalLocaleName)
      Helper method to convert String representation of Locale into Locale object.
      Parameters:
      portalLocaleName - String representation of Locale
      Returns:
      locale

    • getLocaleAsString

      public static String getLocaleAsString(Locale locale)
      Helper method to get a String representation of the Locale
      Parameters:
      locale -
      Returns:
      String representation of the locale