oracle.apps.fnd.applcore.common.biPrefs
Interface PreferencesExtractor

All Known Implementing Classes:

PreferencesExtractorImpl

public interface PreferencesExtractor

This class uses the cookies present in the request to provide ApplCore session preferences. Instead of a more general dependency on HttpServletRequest, an explicit dependency on cookies has been used. This is because the current implementation of the BI proxy servlet imposes certain requirements on code running within the webapp, in particular with regard to certain methods on the servlet request. In order to prevent unexpected calls to the servlet request API, it is proposed that a restrictive, and minimalistic contract be used here.

Method Summary

boolean	checkPrefsUpdateRequired(javax.servlet.http.Cookie[] cookies, java.lang.String cacheKey) This method checks the current set of cookies to see if any pillar update has occurred for preferences since the last time preferences were retrieved.
UserPreferences	getPreferences(ConfigurationProvider cfgProvider, javax.servlet.http.Cookie[] cookies, java.lang.String userName) This method will retrieve the user preferences properties by invoking the Applsession webservice.
UserPreferences	getPreferencesFromLdap(java.lang.String userName) Deprecated. kept for backward compatibilty Get the User preferences from the LDAP server

Method Detail

checkPrefsUpdateRequired

boolean checkPrefsUpdateRequired(javax.servlet.http.Cookie[] cookies,
                                 java.lang.String cacheKey)

This method checks the current set of cookies to see if any pillar update has occurred for preferences since the last time preferences were retrieved. If cacheKey is null,this method always returns true. Or if it indicates that information was retrievd from LDAP last time it will return false.

Parameters:

cookies - Collection of cookies in the current request

cacheKey - Cache key returned by previous call to getPreferences or null

Returns:

True if an update to preferences is required, false otherwise.

getPreferences

UserPreferences getPreferences(ConfigurationProvider cfgProvider,
                               javax.servlet.http.Cookie[] cookies,
                               java.lang.String userName)

This method will retrieve the user preferences properties by invoking the Applsession webservice. In case theres is no Cookie info or the session webservice is not available the required information will be retrieved from the LDAP complete set of session properties and returns them

Parameters:

cfgProvider - Abstract interface which provides configuration parameters

cookies - Collection of cookies in the current request

userName - this parameter is needed in case LDAP needs to be queried

Returns:

getPreferencesFromLdap

UserPreferences getPreferencesFromLdap(java.lang.String userName)

Deprecated. kept for backward compatibilty Get the User preferences from the LDAP server

Parameters:

userName -

Returns: