Skip navigation links

oracle.webcenter.generalsettings.model
Class LanguageSetting

java.lang.Object
oracle.webcenter.generalsettings.internal.model.GSPreferences
oracle.webcenter.generalsettings.model.LanguageSetting

public class LanguageSetting

extends oracle.webcenter.generalsettings.internal.model.GSPreferences

The LanguageSetting class provides shared preferences for language settings. Gets and sets the locale preference for a user. This class must be used when an application is required to override the locale setting from each user's browser. By default, the locale is selected based on the HTTP request object and specified by the user in their browser settings. To allow users to specify their preferred locale in the application, this class must be used along with a ServletFilter to get the preferred locale, through LanguageSetting.getLocale(), and set it in the ADFContext.

Field Summary

static java.lang.String

PREFERRED_LANGUAGE_KEY The internal key that holds the preference value.

Fields inherited from class oracle.webcenter.generalsettings.internal.model.GSPreferences

NULL_VALUE

Constructor Summary

LanguageSetting()

Method Summary

static java.lang.String	getDefaultLanguage() Returns the default language preference for the application.
static java.util.Locale	getLocale() Returns the Locale to use based on the preference set by the current user.
static java.util.Locale	getLocale(java.lang.String username) Returns the Locale to use based on the preference set by the given user.
static java.lang.String	getPreferredLanguage() Returns the preferred language for the current user.
static java.lang.String	getPreferredLanguage(boolean considerCookie) Returns the preferred language for the current user.
static java.lang.String	getPreferredLanguage(java.lang.String username) Returns the preferred language for the given user.
static java.lang.String	getPreferredLanguage(java.lang.String username, boolean considerCookie) Returns the preferred language for the given user.
static java.lang.String	getPreferredUserDisplayNameLanguage() Returns the user display name language for the current user.
static java.lang.String	getPreferredUserDisplayNameLanguage(java.lang.String username) Returns the user display name language for the given user.
static java.lang.String	getUserDisplayNameLanguagePref() Returns the user display name language preference for the current user.
static java.lang.String	getUserDisplayNameLanguagePref(java.lang.String username) Returns the user display name language preference for the given user.
static java.util.Locale	getUserDisplayNameLocale() Returns the Locale to use for display names based on the preference set by the current user.
static java.util.Locale	getUserDisplayNameLocale(java.lang.String username) Returns the Locale to use for display names based on the preference set by the given user.
static java.lang.String	getUserLanguagePref() Returns the language preference for the current user.
static java.lang.String	getUserLanguagePref(java.lang.String username) Returns the language preference for the given user.
static void	setDefaultLanguage(java.lang.String defaultLanguage) Sets the default language preference for the application.
static void	setPreferredLanguage(java.lang.String preferredLanguage) Deprecated. replaced by setUserLanguagePref
static void	setPreferredLanguage(java.lang.String username, java.lang.String preferredLanguage) Deprecated. replaced by setUserLanguagePref
static void	setUserDisplayNameLanguagePref(java.lang.String username, java.lang.String userNameDisplayLanguage) Sets the display name language preference for the given user.
static void	setUserLanguagePref(java.lang.String preferredLanguage) Sets the language preference for the current user.
static void	setUserLanguagePref(java.lang.String username, java.lang.String preferredLanguage) Sets the language preference for the given user.

Methods inherited from class oracle.webcenter.generalsettings.internal.model.GSPreferences

getPreferred, getPreferred, getProvider, getSystemPref, getUserPref, getUserPref, log, setSystemPref, setUserPref

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PREFERRED_LANGUAGE_KEY

public static final java.lang.String PREFERRED_LANGUAGE_KEY

The internal key that holds the preference value.

See Also:

Constant Field Values

Constructor Detail

LanguageSetting

public LanguageSetting()

Method Detail

getPreferredLanguage

public static java.lang.String getPreferredLanguage()

Returns the preferred language for the current user. If the user and default preferences are not set, returns null.

Returns:

user's preferred language

getPreferredLanguage

public static java.lang.String getPreferredLanguage(java.lang.String username)

Returns the preferred language for the given user. If the user and default preferences are not set, returns null.

Parameters:

username - the username to obtain the preference for. If null, obtains the preference for the current authenticated user

Returns:

user's preferred language

getPreferredLanguage

public static java.lang.String getPreferredLanguage(boolean considerCookie)

Returns the preferred language for the current user. If user and default preferences are not set, returns null

Parameters:

considerCookie - whether to consider the values from the cookies

Returns:

user's preferred language, null if user and default preferences do not exist

getPreferredLanguage

public static java.lang.String getPreferredLanguage(java.lang.String username,
                                                    boolean considerCookie)

Returns the preferred language for the given user. If user and default preferences are not set, returns null.

Parameters:

username - the username to obtain the preference for. If null, obtains the preference for the current authenticated user

considerCookie - whether to consider the values from the cookies

Returns:

user's preferred language, null if user and default preferences do not exist

getPreferredUserDisplayNameLanguage

public static java.lang.String getPreferredUserDisplayNameLanguage(java.lang.String username)

Returns the user display name language for the given user. If the user and default preferences are not set, returns null.

Parameters:

username - the username to obtain the preference for. If null, obtains the preference for the current authenticated user

Returns:

user's preferred username display language

getPreferredUserDisplayNameLanguage

public static java.lang.String getPreferredUserDisplayNameLanguage()

Returns the user display name language for the current user. If the user and default preferences are not set, returns null.

Returns:

user's preferred username display language

getUserLanguagePref

public static java.lang.String getUserLanguagePref()

Returns the language preference for the current user. If the user preference is not set, returns null. This API is designed to be used in a user preference setting UI, for all other uses, the getPreferredLanguage() API should be used.

Returns:

user's language preference. If user preference is not set returns null.

getUserLanguagePref

public static java.lang.String getUserLanguagePref(java.lang.String username)

Returns the language preference for the given user. If the user preference is not set, returns null. This API is designed to be used in a user preference setting UI, for all other uses, the getPreferredLanguage() API should be used.

Parameters:

username - the username to obtain the preference for. If null, obtains the preference for the current authenticated user

Returns:

user's language preference. If the user preference is not set, returns null

getUserDisplayNameLanguagePref

public static java.lang.String getUserDisplayNameLanguagePref(java.lang.String username)

Returns the user display name language preference for the given user. If the user preference is not set, returns null. This API is designed to be used in a user preference setting UI, for all other uses, the getPreferredUserDisplayNameLanguage() API should be used.

Parameters:

username - the username to obtain the preference for. If null, obtains the preference for the current authenticated user

Returns:

user's display name language preference. If the user preference is not set, returns null

getUserDisplayNameLanguagePref

public static java.lang.String getUserDisplayNameLanguagePref()

Returns the user display name language preference for the current user. If the user preference is not set, returns null. This API is designed to be used in a user preference setting UI, for all other uses, the getPreferredUserDisplayNameLanguage() API should be used.

Returns:

user's display name language preference. If the user preference is not set, returns null

setPreferredLanguage

public static void setPreferredLanguage(java.lang.String username,
                                        java.lang.String preferredLanguage)

Deprecated. replaced by setUserLanguagePref

setPreferredLanguage

public static void setPreferredLanguage(java.lang.String preferredLanguage)

Deprecated. replaced by setUserLanguagePref

setUserLanguagePref

public static void setUserLanguagePref(java.lang.String preferredLanguage)

Sets the language preference for the current user.

Parameters:

preferredLanguage - user's language preference

setUserLanguagePref

public static void setUserLanguagePref(java.lang.String username,
                                       java.lang.String preferredLanguage)

Sets the language preference for the given user.

Parameters:

username - the username to set the preference for. If null, sets the preference for the current authenticated user

preferredLanguage - user's language preference

setUserDisplayNameLanguagePref

public static void setUserDisplayNameLanguagePref(java.lang.String username,
                                                  java.lang.String userNameDisplayLanguage)

Sets the display name language preference for the given user.

Parameters:

username - the username to set the preference for. If null, sets the preference for the current authenticated user

userNameDisplayLanguage - user's language preference

getDefaultLanguage

public static java.lang.String getDefaultLanguage()

Returns the default language preference for the application. If the system preference is not set, returns null.

Returns:

the application's default language preference setting

setDefaultLanguage

public static void setDefaultLanguage(java.lang.String defaultLanguage)

Sets the default language preference for the application.

Parameters:

defaultLanguage - the application's default language preference

getLocale

public static java.util.Locale getLocale()

Returns the Locale to use based on the preference set by the current user. If the application is required to override the locale setting from each user's browser, then this API must be used in a custom ServletFilter to set the Locale value in ADFContext which is used by Faces and all WebCenter services. Without this the locale specified by the user's browser will be used.

Returns:

Locale to use for all localization

getLocale

public static java.util.Locale getLocale(java.lang.String username)

Returns the Locale to use based on the preference set by the given user. If the application is required to override the locale setting from each user's browser, then this API must be used in a custom ServletFilter to set the Locale value in ADFContext which is used by Faces and all WebCenter services. Without this the locale specified by the user's browser will be used.

Parameters:

username - the username to obtain the preference for. If null, obtains the preference for the current authenticated user

Returns:

Locale to use for all localization

getUserDisplayNameLocale

public static java.util.Locale getUserDisplayNameLocale()

Returns the Locale to use for display names based on the preference set by the current user.

Returns:

Locale to use for display names

getUserDisplayNameLocale

public static java.util.Locale getUserDisplayNameLocale(java.lang.String username)

Returns the Locale to use for display names based on the preference set by the given user.

Parameters:

username - the username to obtain the preference for. If null, obtains the preference for the current authenticated user

Returns:

Locale to use for display names

Skip navigation links