com.sapportals.portal.navigation

Interface INavigationRedirector

All Known Implementing Classes:

AbstractNavigationRedirector

public interface INavigationRedirector

The interface that redirects the original URL that initiated the navigation to a different URL. You do not have to implement a redirector for your navigation connector. However, you can only register a redirector at the same time that you register a navigation connector.

The prefix can either be an indication for a connector or a definition of a redirector.

A redirector is responsible for translating the URL from the original URL to another URL format. The returned object should always contain both the URL and the new prefix. If the new prefix is a connector prefix, no additional redirection is required. If the prefix is a redirector prefix, then cascading redirection is required.

Note: A redirector is bound to a specific prefix, and is registered together with the connector registration.

For example, when calling the client-side eventing doNavigate method using navigationTarget, pcd:portal_content/portal/firstPage is not recognized by any registered connector. This URL should first be redirected using the PCD redirector implementation. Assume that in this case, the returned value contains the ROLES prefix, so the URL can now be processed.

Examples of redirectors are:

• ROLESH (represents PCD hash code URLs) to PCD
• PCD to ROLES
• ROLESH to ROLES

See Also:

INavigationRedirectorResult

Method Summary

INavigationRedirectorResult

redirect(String oldURL, Hashtable environment) Redirects the specified URL to a format that can be read by either one of the connectors or by another redirector implementation.

Method Detail

redirect

INavigationRedirectorResult redirect(String oldURL,
                                     Hashtable environment)
                                     throws NamingException

Redirects the specified URL to a format that can be read by either one of the connectors or by another redirector implementation.

Note: A redirector must return a new prefix for the returned URL.

Parameters:

oldURL - the original URL, without its prefix

environment - the user context

Returns:

the translated URL and its new prefix

Throws:

NamingException - if the original URL is not found

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-RUNTIME	[sap.com] tc/ep/navigation/api	api	EP-PIN