Package com.saperion.ngc.util

Class LocalizationUtil

java.lang.Object
com.saperion.ngc.util.LocalizationUtil
All Implemented Interfaces:
Serializable
public class LocalizationUtil extends Object implements Serializable
Utility class for localization.
See Also:

  • Field Details

    • WEB_APP_ATTR

      public static final String WEB_APP_ATTR
      Name of the attribute used to store this utility in the zk-webapp.
      See Also:

  • Constructor Details

    • LocalizationUtil

      public LocalizationUtil()
      Constructor that is called by web application init listener. To get a LocalizationUtil instance, use the getInstance or getInstanceExternal methods.

  • Method Details

    • getCurrentLocale

      public static Locale getCurrentLocale()
      Gets the current locale.
      Returns:
      the current locale

    • getCurrentLocale

      public static Locale getCurrentLocale(jakarta.servlet.http.HttpSession session)
      Gets the current locale. Uses the specified session to read attributes from.
      Parameters:
      session - the session
      Returns:
      the current locale

    • setCurrentLocale

      public static void setCurrentLocale(Locale aLocale)
      Parameters:
      aLocale - the currentLocale to set

    • setCurrentLocale

      public static void setCurrentLocale(Locale aLocale, jakarta.servlet.http.HttpSession session)
      Parameters:
      aLocale - the currentLocale to set

    • getDisplayLanguage

      public static String getDisplayLanguage()
      Get current Display Language in english.
      Returns:
      the displayLanguage

    • getInstance

      public static LocalizationUtil getInstance()
      Get LocalizationUtil Instance.
      Returns:
      LocalizationUtil

    • getInstanceExternal

      public static LocalizationUtil getInstanceExternal(jakarta.servlet.ServletContext context)
      Get LocalizationUtil Instance. Can be called from without ZK context.
      Parameters:
      context - current servlet context
      Returns:
      LocalizationUtil

    • webLocalize

      public String webLocalize(String key)
      Localize a string using the localizations resource bundle. Use this method to localize keys from LocalizationConstants.
      Parameters:
      key - Key
      Returns:
      Localized string

    • staticWebLocalize

      public static String staticWebLocalize(String key)
      Localize a string using the localizations resource bundle. Use this method to localize keys from LocalizationConstants. Same as webLocalize but accessible from static methods.
      Parameters:
      key - Key
      Returns:
      Localized string

    • webLocalize

      public String webLocalize(String key, jakarta.servlet.http.HttpSession session)
      Localize a string using the localizations resource bundle. Use this method to localize keys from LocalizationConstants.
      Parameters:
      key - Key
      session - the current session
      Returns:
      Localized string

    • sessionLocalize

      public static String sessionLocalize(String key)
      Returns the session stored messages by the given key if existing. Returns null if no session is available or no message with the given key exists in the session. Session based messages are stored by ServiceView.registerSessionAttributes.
      Parameters:
      key - The key of the message to retrieve.
      Returns:
      The requested message or null if no session is available no message exists by the given key.

    • coreLocalize

      public String coreLocalize(String key)
      Localize a core string using the strings resource bundle. Use this method to localize a key from CoreResources.
      Parameters:
      key - Key
      Returns:
      Localized key

    • coreLocalize

      public String coreLocalize(String key, jakarta.servlet.http.HttpSession session)
      Localize a core string using the strings resource bundle. Use this method to localize a key from CoreResources.
      Parameters:
      key - Key
      session - the current session
      Returns:
      Localized key

    • databaseLocalize

      public String databaseLocalize(String toLocalize)
      Localizes a string for the current client locale using the localize table on the database and a localizeUtilCache for holding localized Strings in a cache. If the cache is not activated (configurable in web.xml) the standard localization handling is used instead.
      Parameters:
      toLocalize - string to localize
      Returns:
      localized string or the original string if no localized string was found

    • localize

      public static String localize(String baseName, String key, jakarta.servlet.http.HttpSession session)
      Localize the key with the given localization bundle.
      Parameters:
      baseName - Bundle name
      key - Key
      session - Session
      Returns:
      Localized value

    • cacheLocalize

      protected String cacheLocalize(String toLocalize, Locale clientLocale) throws com.saperion.cache.exception.CacheException, com.saperion.cache.exception.ElementNotFoundException, com.saperion.cache.exception.CorruptElementException
      Throws:
      com.saperion.cache.exception.CacheException
      com.saperion.cache.exception.ElementNotFoundException
      com.saperion.cache.exception.CorruptElementException

    • localizeFolderPath

      public String localizeFolderPath(String pathToLocalize)
      Localizes a folder path.
      Parameters:
      pathToLocalize - path to localize
      Returns:
      localized path

    • resolveLocale

      public static Locale resolveLocale(String webLocale)
      resolve Country and Language from a Locale String like "de_DE".
      Parameters:
      webLocale - webLocale
      Returns:
      locale Locale

    • resolveLocale

      public static String resolveLocale(Locale locale)
      resolve Country and Language from a Locale to a String like "de_DE".
      Parameters:
      locale - locale
      Returns:
      locale String

    • resolveToStringArray

      @Deprecated public static ArrayList<String> resolveToStringArray(String valuesConcatinated)
      Deprecated.
      will be removed in 8.1
      resolve values concatinated Strings seperated with "," to an ArrayList .
      Parameters:
      valuesConcatinated - valuesConcatinated
      Returns:
      arraylist resultArray

    • getSupportedLocales

      @Deprecated public ArrayList<Locale> getSupportedLocales()
      Deprecated.
      use getAllSupportedLocales() instead. Will be removed in 8.1
      resolve supportedLocales form web.xml.
      Returns:
      supportedLocales resultArray

    • getAllSupportedLocales

      public List<Locale> getAllSupportedLocales()
      Returns a list of all supported locales as configured in webclient.properties. The returned list is not modifiable.
      Returns:
      list of supported locales

    • getDefaultLocale

      public static Locale getDefaultLocale()
      resolve defaultLocale form web.xml.
      Returns:
      supportedLocales resultArray

    • isSupportedLocale

      public boolean isSupportedLocale(Locale locale)
      Checks if the specified locale is supported.
      Parameters:
      locale - locale to check
      Returns:
      true if the specified locale is supported, otherwise false

    • getSupportedLocale

      public Locale getSupportedLocale()
      Check if the initial browser Locale or current Locale is one of the supported Locales.If this Locale is not supported we use the defaultLocale.
      Returns:
      supportedLocale

    • getSupportedLocale

      public Locale getSupportedLocale(jakarta.servlet.http.HttpSession session)
      Check if the initial browser Locale or current Locale is one of the supported Locales.If this Locale is not supported we use the defaultLocale.
      Parameters:
      session - the current session
      Returns:
      supportedLocale