oracle.apps.fnd.applcore.patterns.uishell.internal
Class ExternalServicesAdapter

java.lang.Object
  oracle.apps.fnd.applcore.patterns.uishell.internal.ExternalServicesAdapter

public class ExternalServicesAdapter
extends java.lang.Object

Constructor Summary

ExternalServicesAdapter()

Method Summary

static java.lang.String	getDeploymentName(java.lang.String documentRoot) Get the web app name for the given document root.
static java.lang.String	getDiagnosticsDashboardUrl()
static java.lang.String	getDiagnosticsLinkFromProfile() Deprecated. As of D8B4, construct the url from FND_DEPLOYMENTS or its equivalent instead.
static java.lang.String	getMoreHelpPortalUrl(java.lang.String uapKey, java.lang.String language, java.lang.String territory, java.lang.String release, java.lang.String industry, java.lang.String taskId, java.lang.String currentWorkArea, java.lang.String moreHelpUrl) Create the More Help URL to be redirected to the HelpPortal.
static java.lang.String	getPortalUrlForGlobalHelp(java.lang.String language, java.lang.String territory, java.lang.String release, java.lang.String industry, java.lang.String taskId, java.lang.String currentWorkArea, java.lang.String portalHelp) Create the Global Portal Help URL to be redirected to the HelpPortal.
static java.lang.String	getProfileValue(java.lang.String profileName) Utility method to get the Profile Value for a given Profile Name using the ProfileServiceAM.
static java.lang.String	getRemoteHelpPortalFlagFromFSFeatureAPI(java.lang.String amName, java.lang.String amDefFullName) This method returns Access To Internet-Based Help Features value from FS API.
static java.lang.String	getURLForNavigate(java.lang.String webappName) Get the URL for navigating to the web app.
static java.lang.String[]	getURLsForNavigate(java.lang.String[] webappNames)
static java.lang.String	getUserModuleNameForProductCode(java.lang.String productCode, boolean family) Method added for ER 12757634.
static java.lang.String	getUtilAppFromClientDocumentRoot(java.lang.String clientDocumentRoot) Deprecated. This API will return only null and should not be used.
static java.util.List<HelpTopicItem>	getValuesForHelpTopicsOnUAWebService(java.lang.String uapKey, java.lang.String language, java.lang.String territory, java.lang.String release, java.lang.String industry, java.lang.String taskId, java.lang.String currentWorkArea) Get the Help Portal Topics for Help to be displayed in UAPopup.
static void	loginSSOSession(java.lang.String successUrl, java.lang.String cancelUrl, java.util.Map<java.lang.String,?> props)
static void	persistRecentItems(java.lang.String triggeringEvent) Hook to call RecentItemsHandler to persist Recent Items into DB on navigate events
static java.lang.String	setProfileValue(java.lang.String profileName, java.lang.String levelName, java.lang.String levelValue, java.lang.String profileValue) Utility method to set the Profile Value for a given Profile Name using the ProfileServiceAM.
static void	signout() This method handles signing out an authenticated user.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalServicesAdapter

public ExternalServicesAdapter()

Method Detail

getURLForNavigate

public static java.lang.String getURLForNavigate(java.lang.String webappName)

Get the URL for navigating to the web app.

Parameters:

webappName - Web App name, this value should be the deployment_name in FND_DEPLOYMENTS table.

Returns:

URL for navigation.

getDiagnosticsLinkFromProfile

public static java.lang.String getDiagnosticsLinkFromProfile()

Deprecated. As of D8B4, construct the url from FND_DEPLOYMENTS or its equivalent instead.

Get the diagnostics URL from the profile value using the profile name DIAGNOSTICS_DASHBOARD_URL. Thid method is deprecated. The url should not be retrieved from profiles anymore.

Returns:

diagnostics URL

getValuesForHelpTopicsOnUAWebService

public static java.util.List<HelpTopicItem> getValuesForHelpTopicsOnUAWebService(java.lang.String uapKey,
                                                                                 java.lang.String language,
                                                                                 java.lang.String territory,
                                                                                 java.lang.String release,
                                                                                 java.lang.String industry,
                                                                                 java.lang.String taskId,
                                                                                 java.lang.String currentWorkArea)

Get the Help Portal Topics for Help to be displayed in UAPopup. Makes a call to get the profile for the Global Help Link and then call the Web Servide Client to get the Help Portal Links.

Parameters:

uapKey -

language -

territory -

release -

industry -

taskId -

currentWorkArea -

Returns:

list of HelpTopicItem's

getMoreHelpPortalUrl

public static java.lang.String getMoreHelpPortalUrl(java.lang.String uapKey,
                                                    java.lang.String language,
                                                    java.lang.String territory,
                                                    java.lang.String release,
                                                    java.lang.String industry,
                                                    java.lang.String taskId,
                                                    java.lang.String currentWorkArea,
                                                    java.lang.String moreHelpUrl)

Create the More Help URL to be redirected to the HelpPortal.

Parameters:

uapKey -

language -

territory -

release -

industry -

taskId -

currentWorkArea -

Returns:

url for More Help

getPortalUrlForGlobalHelp

public static java.lang.String getPortalUrlForGlobalHelp(java.lang.String language,
                                                         java.lang.String territory,
                                                         java.lang.String release,
                                                         java.lang.String industry,
                                                         java.lang.String taskId,
                                                         java.lang.String currentWorkArea,
                                                         java.lang.String portalHelp)

Create the Global Portal Help URL to be redirected to the HelpPortal.

Parameters:

language -

territory -

release -

industry -

taskId -

currentWorkArea -

Returns:

url for More Help

getProfileValue

public static java.lang.String getProfileValue(java.lang.String profileName)

Utility method to get the Profile Value for a given Profile Name using the ProfileServiceAM. ProfileServiceAM is used since we do not have any AM or VO's.

Parameters:

profileName -

Returns:

profileValue

setProfileValue

public static java.lang.String setProfileValue(java.lang.String profileName,
                                               java.lang.String levelName,
                                               java.lang.String levelValue,
                                               java.lang.String profileValue)

Utility method to set the Profile Value for a given Profile Name using the ProfileServiceAM. ProfileServiceAM is used since we do not have any AM or VO's.

Parameters:

profileName - Name of profile

levelName - Name of level. Must be a valid level for the profile hierarchy, for DEFAULT one of: SITE, PRODUCT, USER.

levelValue - Level value. Must be a valid value for this level.

profileValue - New profile value. Must be a valid value for this profile, and must be non-null. Use clearProfileValue() to remove a profile value.

getUtilAppFromClientDocumentRoot

public static java.lang.String getUtilAppFromClientDocumentRoot(java.lang.String clientDocumentRoot)

Deprecated. This API will return only null and should not be used.

Parameters:

clientDocumentRoot - - Name of the application for which the Utility App Name needs to be fetched.

Returns:

- Utility App Name.

getDeploymentName

public static java.lang.String getDeploymentName(java.lang.String documentRoot)

Get the web app name for the given document root.

Parameters:

documentRoot - document root of the current page.

Returns:

String web app name

signout

public static void signout()

This method handles signing out an authenticated user. It first terminates the ApplSession and clears it out of the cookie. Handling the above case gracefully, it then terminates the Authenticated session by calling AuthenticationServiceUtil.getAuthenticationService().logout(URL, Map<>). This in turn performs SSO, non-SSO logout as well invalidates HTTP session. This should not be used by individual applications directly as it is specifically called by UIShell Page template.

loginSSOSession

public static void loginSSOSession(java.lang.String successUrl,
                                   java.lang.String cancelUrl,
                                   java.util.Map<java.lang.String,?> props)

persistRecentItems

public static void persistRecentItems(java.lang.String triggeringEvent)

Hook to call RecentItemsHandler to persist Recent Items into DB on navigate events

Parameters:

triggeringEvent - Signifies which event calls it. Current accepted input paramaters are signOut, navigateExternal

getRemoteHelpPortalFlagFromFSFeatureAPI

public static java.lang.String getRemoteHelpPortalFlagFromFSFeatureAPI(java.lang.String amName,
                                                                       java.lang.String amDefFullName)

This method returns Access To Internet-Based Help Features value from FS API.

Returns:

getDiagnosticsDashboardUrl

public static java.lang.String getDiagnosticsDashboardUrl()

getURLsForNavigate

public static java.lang.String[] getURLsForNavigate(java.lang.String[] webappNames)

getUserModuleNameForProductCode

public static java.lang.String getUserModuleNameForProductCode(java.lang.String productCode,
                                                               boolean family)

Method added for ER 12757634. The method returns the userModule name based on productCode for product and moduleKey for product family.

Parameters:

productCode -

family -

Returns:

userModuleName