com.pingidentity.pa.sdk.localization

Interface LocaleOverrideService

public interface LocaleOverrideService

A LocaleOverrideService is a singleton plugin that can apply custom logic for resolving the locale of a HTTP request. This locale is used for localization of content in HTTP responses generated by PingAccess.

A custom LocaleOverrideService will replace the default override logic. The default logic uses the ping-accept-language HTTP cookie to determine the locale.

Implementing a LocaleOverrideService

Provider-configuration file

The fully qualified class name for an implementation of LocaleOverrideService should be placed in a META-INF/services/com.pingidentity.pa.sdk.localization.LocaleOverrideService resource file that is packaged in the jar containing the compiled class for the implementation. This signals to PingAccess that the class is a valid LocaleOverrideService implementation.

See Also:

com.pingidentity.pa.sdk.plugins

Method Summary

Modifier and Type	Method and Description
List<Locale>	getPreferredLocales(Exchange exchange) Resolves preferred locales for the given request.

Method Detail

getPreferredLocales

List<Locale> getPreferredLocales(Exchange exchange)

Resolves preferred locales for the given request.

Parameters:

exchange - the Exchange

Returns:

An ordered list of locales in order of preference. An empty result will resolve the locale using the Accept-Language header.