Package com.pingidentity.sdk.locale

Interface LocaleOverrideService

public interface LocaleOverrideService
Interface that defines the methods that PingFederate calls when determining if the user has overridden the browser locale.
Since:
6.11

  • Method Summary

    Modifier and Type
    Method
    Description
    Locale
    getLocale(jakarta.servlet.http.HttpServletRequest request)
    Method to determine if a user has overridden the browser's default locale.
    Locale
    getLocale(javax.servlet.http.HttpServletRequest request)
    Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • getLocale

      @Deprecated(since="13.1", forRemoval=true) Locale getLocale(javax.servlet.http.HttpServletRequest request)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Method to determine if a user has overridden the browser's default locale. For example, this method can be used to check for the existence of a cookie which defines a user's preferred locale. Returning null will cause PingFederate to fall back to its default locale handling.
      Parameters:
      request - The HttpServletRequest can be used to read cookies, parameters, headers, etc. Accessing the HttpSession from the request is not recommended and doing so is deprecated. Use SessionStateSupport as an alternative.
      Returns:
      The user's preferred locale. Return null if the user has not overridden the default locale.
      See Also:

    • getLocale

      Locale getLocale(jakarta.servlet.http.HttpServletRequest request)
      Method to determine if a user has overridden the browser's default locale. For example, this method can be used to check for the existence of a cookie which defines a user's preferred locale. Returning null will cause PingFederate to fall back to its default locale handling.
      Parameters:
      request - The HttpServletRequest can be used to read cookies, parameters, headers, etc. Accessing the HttpSession from the request is not recommended and doing so is deprecated. Use SessionStateSupport as an alternative.
      Returns:
      The user's preferred locale. Return null if the user has not overridden the default locale.
      See Also: