com.sapportals.wcm.service.urlgenerator

Interface IURLGenerator

Deprecated. as of EP 5.0 SP5, replaced by interface IURLGeneratorService

public interface IURLGenerator

Services, controls, repositories need to access resources, which are accessible only through their respective URLs. This interface offers methods to create URLs for certain resources, to build valid URLs from partial information known to the calling object by adding information from the configuration of the running system. This allows to create complete URLs, pointing to a webpage that can e.g. be included in an email or as link on another page. To obtain a valid instance of an URLGenerator, proceed as follows:

   IURLGenerator ug = (IURLGenerator)ResourceFactory.getInstance()
                                    .getServiceFactory()
                                    .getService(IServiceTypesConst.URLGENERATOR_SERVICE);
 

A standard usecase would be to offer a link on a webpage that allows the user to navigate to the details of a given resource:

   String linkreference = ug.createLinkToDetailsPageRID(resource.getRID()).toString();
 

Please note, that some of the methods will return a complete URL, including protocol and server while others may only return a relative URL. Also, some of the returned RID have a query-parameter attached, so be careful when transforming into String.

Most field variables are explained in the package-html and in the configuration framework. They are needed for the internal mapping of configuration values to the internal variables. For the method getValue , use these field variables as parameter-keys. The method will then return the value configured for this key in the configuration framework.

Copyright 2004 SAP AG

See Also:

RID

Field Summary

static String	CONFIG_CHARCLOSE Deprecated.
static String	CONFIG_CHAROPEN Deprecated.
static String	TAG_APPLOG_DOWNLOAD_SERVLET_PATH Deprecated. TAG-Variables are used as keys for the given properties
static String	TAG_APPLOG_PATH Deprecated.
static String	TAG_BUSINESS_CARD_PATH Deprecated.
static String	TAG_CONTENT_ACCESS_PATH Deprecated.
static String	TAG_DEFAULT_CONFIG_FILE_NAME Deprecated.
static String	TAG_DETAILSPAGE Deprecated.
static String	TAG_ENVIRONMENT Deprecated.
static String	TAG_EXPLORER_SERVLET_PATH Deprecated.
static String	TAG_FAVORITES Deprecated.
static String	TAG_FOLDER_ACCESS_PATH Deprecated.
static String	TAG_GROUPRESOURCE Deprecated.
static String	TAG_HOST Deprecated.
static String	TAG_ICE_PATH Deprecated.
static String	TAG_IMAGE_PATH Deprecated.
static String	TAG_JBUILDER Deprecated. as of NW04.
static String	TAG_LINKLIST Deprecated.
static String	TAG_ROLERESOURCE Deprecated.
static String	TAG_SERVICE_SERVLET_PATH Deprecated.
static String	TAG_TOMCAT Deprecated. as of NW04.
static String	TAG_USER_RESOURCE_FORMAT_PHOTO Deprecated.
static String	TAG_USER_RESOURCE_FORMAT_RDF Deprecated.
static String	TAG_USER_RESOURCE_FORMAT_VCARD Deprecated.
static String	TAG_USERHOME Deprecated.
static String	TAG_USERMAPPING_SERVLET_PATH Deprecated.
static String	TAG_USERRESOURCE Deprecated.
static String	TAG_VIEWER_PATH Deprecated.
static String	TAG_WEBRM_ACCESS_PATH Deprecated.
static String	TAG_XML_FORMS_CSS Deprecated.
static String	TAG_XML_FORMS_CSS_URL Deprecated.
static String	TAG_XML_FORMS_EDITSERVLET_PATH Deprecated.
static String	TAG_XML_FORMS_LISTSERVLET_PATH Deprecated.
static String	TAG_XML_FORMS_PREVIEWSERVLET_PATH Deprecated.
static String	TAG_XML_FORMS_XFBUILDERSERVLET_PATH Deprecated.
static String	USER_BRIEFCASE Deprecated.
static String	USER_CLIPBOARD Deprecated.
static String	USER_FAVORITES Deprecated.
static String	USER_INBOX Deprecated.
static String	USER_LINKS Deprecated.
static String	USER_QUERIES Deprecated.
static String	USER_RESOURCE_FORMAT_PHOTO Deprecated.
static String	USER_RESOURCE_FORMAT_RDF Deprecated.
static String	USER_RESOURCE_FORMAT_VCARD Deprecated.
static String	USER_TEMP Deprecated.

Method Summary

URI	createLinkToDetailsPage(URI resourceURI) Deprecated. as of EP 5.0 SP2, replaced by createLinkToDetailsPageRID(RID)
RID	createLinkToDetailsPageRID(RID resourceRID) Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getResourcePageUri(PathKey, RID, RID) with parameter constant PathKey.DETAILS_PAGE
RID	createLinkToDetailsPageRID(RID resourceRID, RID startRID) Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getResourcePageUri(PathKey, RID, RID) with parameter constant PathKey.DETAILS_PAGE
URI	createLinkToExplorerPage(URI resourceURI) Deprecated. as of EP 5.0 SP2, replaced by createLinkToExplorerPageRID(RID)
RID	createLinkToExplorerPageRID(RID resourceRID) Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getResourcePageUri(PathKey, RID, RID) with parameter constant PathKey.EXPLORER_PAGE
RID	createLinkToExplorerPageRID(RID resourceRID, RID startRID) Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getResourcePageUri(PathKey, RID, RID) with parameter constant PathKey.EXPLORER_PAGE
URI	createServletCall(Properties properties) Deprecated. as of EP 5.0 SP2, replaced by createServletCallRID(Properties)
RID	createServletCallRID(Properties properties) Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getServicePageUri(java.util.List)
String	getAppLogDownloadPath() Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getRelativeUri(PathKey) with parameter constant PathKey.APPLOG_DOWNLOAD_PAGE
String	getAppLogPath() Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getRelativeUri(PathKey) with parameter constant PathKey.APPLOG_PAGE
URI	getBusinessCardApp(com.sapportals.portal.security.usermanagement.IUser user) Deprecated. as of EP 5.0 SP2, replaced by getBusinessCardAppRID(IUser)
URI	getBusinessCardApp(String uid) Deprecated. as of EP 5.0 SP2, replaced by getBusinessCardAppRID(String)
RID	getBusinessCardAppRID(com.sapportals.portal.security.usermanagement.IUser user) Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getBusinessCardUri(String)
RID	getBusinessCardAppRID(String uid) Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getBusinessCardUri(String)
RID	getCompleteRIDToShowFolder(ICollection folder) Deprecated. as of EP 5.0 SP2, replaced by createLinkToExplorerPageRID(RID)
URI	getCompleteURIToShowFolder(ICollection folder) Deprecated. as of EP 5.0 SP2, replaced by getCompleteRIDToShowFolder(ICollection)
String	getContentAccessPath() Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getRelativeUri(PathKey) with parameter constant PathKey.CONTENT_ACCESS_PATH
String	getDefaultConfigFile() Deprecated. as of NW04.
String	getDefaultConfigFile(String key) Deprecated. as of NW04.
String	getEditServletPath() Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getRelativeUri(PathKey) with parameter constant PathKey.XML_FORMS_EDIT_PAGE
String	getExplorerServletPath() Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getRelativeUri(PathKey) with parameter constant PathKey.EXPLORER_PAGE
String	getFavorites() Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getRelativeUri(PathKey) with parameter constant PathKey.FAVORITES_PAGE
String	getFolderAccessPath() Deprecated. as of EP 5.0 SP5, this method has been removed
URI	getGroupResource(com.sapportals.portal.security.usermanagement.IGroup group) Deprecated. as of EP 5.0 SP2, replaced by getGroupResourceRID(IGroup)
URI	getGroupResource(String gid) Deprecated. as of EP 5.0 SP2, replaced by getGroupResourceRID(String)
RID	getGroupResourceRID(com.sapportals.portal.security.usermanagement.IGroup group) Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getGroupResourceRID(IGroup)
RID	getGroupResourceRID(String gid) Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getGroupResourceRID(String)
String	getHost() Deprecated. as of EP 5.0 SP5, this method has been removed
String	getIcePath() Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getRelativeUri(PathKey) with parameter constant PathKey.ICE_SERVER
String	getImage(String filename) Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getImageUri(String)
String	getImagePath() Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getRelativeUri(PathKey) with parameter constant PathKey.IMAGE_PATH
String	getLinkList() Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getRelativeUri(PathKey) with parameter constant PathKey.LINKLIST_PAGE
String	getListServletPath() Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getRelativeUri(PathKey) with parameter constant PathKey.XML_FORMS_LIST_PAGE
String	getPreviewServletPath() Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getRelativeUri(PathKey) with parameter constant PathKey.XML_FORMS_PREVIEW_PAGE
RID	getRIDfromWebURL(URL webAddress) Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.mapUri(IUri)
URI	getRoleResource(com.sapportals.portal.security.usermanagement.IRole group) Deprecated. as of EP 5.0 SP2, replaced by getRoleResourceRID(IRole)
URI	getRoleResource(String rid) Deprecated. as of EP 5.0 SP2, replaced by getRoleResourceRID(String)
RID	getRoleResourceRID(com.sapportals.portal.security.usermanagement.IRole role) Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getRoleResourceRID(IRole)
RID	getRoleResourceRID(String rid) Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getRoleResourceRID(String)
String	getServiceServletPath() Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getRelativeUri(PathKey) with parameter constant PathKey.SERVICE_PAGE.
URI	getUserFolder(com.sapportals.portal.security.usermanagement.IUser user, String folder) Deprecated. as of EP 5.0 SP2, replaced by getUserFolderRID(IUser, String)
RID	getUserFolderRID(com.sapportals.portal.security.usermanagement.IUser user, String folder) Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getUserFolderRID(IUser, String)
URI	getUserHome(com.sapportals.portal.security.usermanagement.IUser user) Deprecated. as of EP 5.0 SP2, replaced by getUserHomeRID(IUser)
RID	getUserHomeRID(com.sapportals.portal.security.usermanagement.IUser user) Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getUserHomeRID(IUser)
String	getUsermappingServlet(String systemId, String successUrl, String failureUrl, String cancelUrl) Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getUsermappingPageUri(String, String, String, String)
URI	getUserResource(com.sapportals.portal.security.usermanagement.IUser user) Deprecated. as of EP 5.0 SP2, replaced by getUserResourceRID(IUser)
URI	getUserResource(com.sapportals.portal.security.usermanagement.IUser user, String format) Deprecated. as of EP 5.0 SP2, replaced by getUserResourceRID(IUser, String)
URI	getUserResource(String uid) Deprecated. as of EP 5.0 SP2, replaced by getUserResourceRID(String)
URI	getUserResource(String uid, String format) Deprecated. as of EP 5.0 SP2, replaced by getUserResourceRID(String, String)
RID	getUserResourceRID(com.sapportals.portal.security.usermanagement.IUser user) Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getUserResourceRID(IUser)
RID	getUserResourceRID(com.sapportals.portal.security.usermanagement.IUser user, String format) Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getUserResourceRID(IUser, String)
RID	getUserResourceRID(String uid) Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getUserResourceRID(String)
RID	getUserResourceRID(String uid, String format) Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getUserResourceRID(String, String)
String	getValue(String key) Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getRelativeUri(PathKey) or IURLGeneratorService.getAbsoluteUri(PathKey)
String	getViewerPath() Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getRelativeUri(PathKey) with parameter constant PathKey#VIEWER_PATH)
String	getXFBuilderServletPath() Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getRelativeUri(PathKey) with parameter constant PathKey.XML_FORMS_XFBUILDER_PAGE
String	replaceURIPlaceholders(String uri, IResource resource) Deprecated. Replaces placeholders in URI
String	replaceURIPlaceholders(String uri, IResourceContext context) Deprecated. Replaces placeholders in URI

Field Detail

USER_INBOX

public static final String USER_INBOX

Deprecated.

See Also:

Constant Field Values

USER_FAVORITES

public static final String USER_FAVORITES

Deprecated.

See Also:

Constant Field Values

USER_LINKS

public static final String USER_LINKS

Deprecated.

See Also:

Constant Field Values

USER_BRIEFCASE

public static final String USER_BRIEFCASE

Deprecated.

See Also:

Constant Field Values

USER_QUERIES

public static final String USER_QUERIES

Deprecated.

See Also:

Constant Field Values

USER_CLIPBOARD

public static final String USER_CLIPBOARD

Deprecated.

See Also:

Constant Field Values

USER_TEMP

public static final String USER_TEMP

Deprecated.

See Also:

Constant Field Values

USER_RESOURCE_FORMAT_RDF

public static final String USER_RESOURCE_FORMAT_RDF

Deprecated.

See Also:

Constant Field Values

USER_RESOURCE_FORMAT_VCARD

public static final String USER_RESOURCE_FORMAT_VCARD

Deprecated.

See Also:

Constant Field Values

USER_RESOURCE_FORMAT_PHOTO

public static final String USER_RESOURCE_FORMAT_PHOTO

Deprecated.

See Also:

Constant Field Values

TAG_APPLOG_DOWNLOAD_SERVLET_PATH

public static final String TAG_APPLOG_DOWNLOAD_SERVLET_PATH

Deprecated.

TAG-Variables are used as keys for the given properties

TAG_APPLOG_PATH

public static final String TAG_APPLOG_PATH

Deprecated.

TAG_CONTENT_ACCESS_PATH

public static final String TAG_CONTENT_ACCESS_PATH

Deprecated.

TAG_DETAILSPAGE

public static final String TAG_DETAILSPAGE

Deprecated.

TAG_EXPLORER_SERVLET_PATH

public static final String TAG_EXPLORER_SERVLET_PATH

Deprecated.

TAG_FAVORITES

public static final String TAG_FAVORITES

Deprecated.

TAG_ICE_PATH

public static final String TAG_ICE_PATH

Deprecated.

TAG_IMAGE_PATH

public static final String TAG_IMAGE_PATH

Deprecated.

TAG_LINKLIST

public static final String TAG_LINKLIST

Deprecated.

TAG_SERVICE_SERVLET_PATH

public static final String TAG_SERVICE_SERVLET_PATH

Deprecated.

TAG_USERMAPPING_SERVLET_PATH

public static final String TAG_USERMAPPING_SERVLET_PATH

Deprecated.

TAG_VIEWER_PATH

public static final String TAG_VIEWER_PATH

Deprecated.

TAG_XML_FORMS_CSS_URL

public static final String TAG_XML_FORMS_CSS_URL

Deprecated.

TAG_XML_FORMS_EDITSERVLET_PATH

public static final String TAG_XML_FORMS_EDITSERVLET_PATH

Deprecated.

TAG_XML_FORMS_LISTSERVLET_PATH

public static final String TAG_XML_FORMS_LISTSERVLET_PATH

Deprecated.

TAG_XML_FORMS_PREVIEWSERVLET_PATH

public static final String TAG_XML_FORMS_PREVIEWSERVLET_PATH

Deprecated.

TAG_XML_FORMS_XFBUILDERSERVLET_PATH

public static final String TAG_XML_FORMS_XFBUILDERSERVLET_PATH

Deprecated.

TAG_BUSINESS_CARD_PATH

public static final String TAG_BUSINESS_CARD_PATH

Deprecated.

See Also:

Constant Field Values

TAG_DEFAULT_CONFIG_FILE_NAME

public static final String TAG_DEFAULT_CONFIG_FILE_NAME

Deprecated.

See Also:

Constant Field Values

TAG_ENVIRONMENT

public static final String TAG_ENVIRONMENT

Deprecated.

See Also:

Constant Field Values

TAG_FOLDER_ACCESS_PATH

public static final String TAG_FOLDER_ACCESS_PATH

Deprecated.

See Also:

Constant Field Values

TAG_HOST

public static final String TAG_HOST

Deprecated.

See Also:

Constant Field Values

TAG_GROUPRESOURCE

public static final String TAG_GROUPRESOURCE

Deprecated.

See Also:

Constant Field Values

TAG_ROLERESOURCE

public static final String TAG_ROLERESOURCE

Deprecated.

See Also:

Constant Field Values

TAG_USERHOME

public static final String TAG_USERHOME

Deprecated.

See Also:

Constant Field Values

TAG_USERRESOURCE

public static final String TAG_USERRESOURCE

Deprecated.

See Also:

Constant Field Values

TAG_WEBRM_ACCESS_PATH

public static final String TAG_WEBRM_ACCESS_PATH

Deprecated.

See Also:

Constant Field Values

TAG_XML_FORMS_CSS

public static final String TAG_XML_FORMS_CSS

Deprecated.

See Also:

Constant Field Values

TAG_USER_RESOURCE_FORMAT_RDF

public static final String TAG_USER_RESOURCE_FORMAT_RDF

Deprecated.

See Also:

Constant Field Values

TAG_USER_RESOURCE_FORMAT_VCARD

public static final String TAG_USER_RESOURCE_FORMAT_VCARD

Deprecated.

See Also:

Constant Field Values

TAG_USER_RESOURCE_FORMAT_PHOTO

public static final String TAG_USER_RESOURCE_FORMAT_PHOTO

Deprecated.

See Also:

Constant Field Values

CONFIG_CHAROPEN

public static final String CONFIG_CHAROPEN

Deprecated.

See Also:

Constant Field Values

CONFIG_CHARCLOSE

public static final String CONFIG_CHARCLOSE

Deprecated.

See Also:

Constant Field Values

TAG_JBUILDER

public static final String TAG_JBUILDER

Deprecated. as of NW04.

See Also:

Constant Field Values

TAG_TOMCAT

public static final String TAG_TOMCAT

Deprecated. as of NW04.

See Also:

Constant Field Values

Method Detail

getUserHomeRID

public RID getUserHomeRID(com.sapportals.portal.security.usermanagement.IUser user)
                   throws WcmException

Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getUserHomeRID(IUser)

Returns the RID to the user's home folder.

Parameters:

user - the user we want to get the home folder for

Returns:

the RID to the user's home folder

Throws:

WcmException - Exception raised in failure situation

getUserFolderRID

public RID getUserFolderRID(com.sapportals.portal.security.usermanagement.IUser user,
                            String folder)
                     throws WcmException

Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getUserFolderRID(IUser, String)

Returns RID for a folder specified by user context and folder name.

Parameters:

user - the user in question

folder - the folder in question

Returns:

the RID to the user/folder combination

Throws:

WcmException - must be thrown, when user is null , implementations of this interface might decide to also throw the exception in additional situations

getHost

public String getHost()

Deprecated. as of EP 5.0 SP5, this method has been removed

Returns the ServerName of the current server the VM is running on.

Returns:

the ServerName of the current server the VM is running on. When the system is running in a cluster environment, the IP-Adress of the load balancer is returned.

getServiceServletPath

public String getServiceServletPath()

Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getRelativeUri(PathKey) with parameter constant PathKey.SERVICE_PAGE.

Returns the ServiceServletPath set for the current server the VM is running on.

Returns:

the ServiceServletPath set for the current server the VM is running on. it consists of the protocol, the host and the serviceservlet path specified in the configuration of the IURLGenerator instance, e.g. http://myserver:8080/serviceservlet

getExplorerServletPath

public String getExplorerServletPath()

Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getRelativeUri(PathKey) with parameter constant PathKey.EXPLORER_PAGE

Returns the ExplorerServletPath set for the current server the VM is running on.

Returns:

the ExplorerServletPath set for the current server the VM is running on. It consists of the protocol, the host and the explorerservlet path specified in the configuration of the IURLGenerator instance, e.g. http://myserver:8080/explorerservlet

getAppLogDownloadPath

public String getAppLogDownloadPath()

Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getRelativeUri(PathKey) with parameter constant PathKey.APPLOG_DOWNLOAD_PAGE

Returns the AppLogDownload set for the current server the VM is running on.

Returns:

the AppLogDownload set for the current server the VM is running on. It consists of the protocol, the host and the applogdownload path specified in the configuration of the IURLGenerator instance, e.g. http://myserver:8080/applogdownload

getAppLogPath

public String getAppLogPath()

Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getRelativeUri(PathKey) with parameter constant PathKey.APPLOG_PAGE

Returns the AppLogPath set for the current server the VM is running on.

Returns:

the AppLogPath set for the current server the VM is running on. It consists of the protocol, the host and the applogdownload path specified in the configuration of the IURLGenerator instance, e.g. http://myserver:8080/applog

getImagePath

public String getImagePath()

Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getRelativeUri(PathKey) with parameter constant PathKey.IMAGE_PATH

Returns the ImagePath set for the current server the VM is running on.

Returns:

the ImagePath set for the current server the VM is running on. It returns a URL that allows to download the wanted image, e.g. when displaying an image on a website. It consists of the ContentAccessPath and the repository and path information to the image folder.

getImage

public String getImage(String filename)

Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getImageUri(String)

Returns the complete ImagePath set for the current server the VM is running on and the filename given.

Parameters:

filename - the name of the file that represents the wanted Image

Returns:

the complete ImagePath set for the current server the VM is running on and the filename given.

See Also:

getImagePath()

getContentAccessPath

public String getContentAccessPath()

Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getRelativeUri(PathKey) with parameter constant PathKey.CONTENT_ACCESS_PATH

Returns the URL to communicate with the WebDAV server of the CM system which allows to retrieve content to e.g. display it in a webbrowser window.

Returns:

the ContentAccessPath set for the current server the VM is running on.

getFolderAccessPath

public String getFolderAccessPath()

Deprecated. as of EP 5.0 SP5, this method has been removed

Returns an url-part to navigate to the servlet which is defined as default to display the content (= children) of a folder

Returns:

the FolderAccessPath set for the current server the VM is running on.

getIcePath

public String getIcePath()

Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getRelativeUri(PathKey) with parameter constant PathKey.ICE_SERVER

Returns the ICE path set for the current server the VM is running on.

Returns:

the ICE path set for the current server the VM is running on.

getFavorites

public String getFavorites()

Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getRelativeUri(PathKey) with parameter constant PathKey.FAVORITES_PAGE

Returns the FavoritesPath set for the current server the VM is running on.

Returns:

the FavoritesPath set for the current server the VM is running on.

getLinkList

public String getLinkList()

Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getRelativeUri(PathKey) with parameter constant PathKey.LINKLIST_PAGE

Returns the LinkListPath set for the current server the VM is running on.

Returns:

the LinkListPath set for the current server the VM is running on. It consists of the protocol, the host and the linklist servlet path specified in the configuration of the IURLGenerator instance, e.g. http://myserver:8080/linklist

getListServletPath

public String getListServletPath()

Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getRelativeUri(PathKey) with parameter constant PathKey.XML_FORMS_LIST_PAGE

Returns the XMLForms ListServletPath set for the current server the VM is running on.

Returns:

the XMLForms ListServletPath set for the current server the VM is running on.

getEditServletPath

public String getEditServletPath()

Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getRelativeUri(PathKey) with parameter constant PathKey.XML_FORMS_EDIT_PAGE

Returns the XMLForms EditServletPath set for the current server the VM is running on.

Returns:

the XMLForms EditServletPath set for the current server the VM is running on.

getPreviewServletPath

public String getPreviewServletPath()

Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getRelativeUri(PathKey) with parameter constant PathKey.XML_FORMS_PREVIEW_PAGE

Returns the XMLForms PreviewServletPath set for the current server the VM is running on.

Returns:

the XMLForms PreviewServletPath set for the current server the VM is running on.

getXFBuilderServletPath

public String getXFBuilderServletPath()

Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getRelativeUri(PathKey) with parameter constant PathKey.XML_FORMS_XFBUILDER_PAGE

Returns the XMLForms XFBuilderServletPath set for the current server the VM is running on.

Returns:

the XMLForms XFBuilderServletPath set for the current server the VM is running on.

getCompleteRIDToShowFolder

public RID getCompleteRIDToShowFolder(ICollection folder)
                               throws WcmException

Deprecated. as of EP 5.0 SP2, replaced by createLinkToExplorerPageRID(RID)

Returns a complete URL to put in a mail or on a html-button to open the folder and its content

Parameters:

folder - the folder to show

Returns:

a complete URL to put in a mail or on a html-button that will open a webpage, showing the folder and its content, returns null , if resource is not a folder Please use createLinkToExplorerPage instead

Throws:

WcmException - Exception raised in failure situation

getViewerPath

public String getViewerPath()

Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getRelativeUri(PathKey) with parameter constant PathKey#VIEWER_PATH)

Returns the url to show the content of a resource

Returns:

the ViewerPath set for the current server the VM is running on. it consists of the protocol, the host and the viewer servlet path specified in the configuration of the IURLGenerator instance, e.g. http://myserver:8080/myViewer

getValue

public String getValue(String key)

Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getRelativeUri(PathKey) or IURLGeneratorService.getAbsoluteUri(PathKey)

Returns the value mapped to the given key.

Parameters:

key - the key of the property to return. Use IURLGenerator.TAG_ constants as keys

Returns:

the value mapped to the key given. returns null , if there is no value for the given key

getDefaultConfigFile

public String getDefaultConfigFile()

Deprecated. as of NW04.

Returns the xmlfile which is set as default in the CM configuration and used for the wdf-navigation.

Returns:

the xmlfile which is set as default in the CM configuration and used for the wdf-navigation

getDefaultConfigFile

public String getDefaultConfigFile(String key)

Deprecated. as of NW04.

Returns the xmlfile which is set as default in the CM configuration and used for the wdf-navigation

Parameters:

key - this is not used anymore

Returns:

the xmlfile which is set as default in the CM configuration and used for the wdf-navigation

createServletCallRID

public RID createServletCallRID(Properties properties)
                         throws WcmException

Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getServicePageUri(java.util.List)

Creates a complete URL to include in emails etc to start a service. The URL will point to a certain control, which understands the given properties. It might immediately carry out some instructions (e.g. delete a resource) or display a dialog. The IWcmConst holds a whole set of parameters starting with SERVICE_SERVLET which can be used as keys or default values in the Properties parameter.

Parameters:

properties - this includes parameters as defined in the IWcmConst.ServiceServletParameters You can also use "free" key-value pairs, but have to make sure, that receiving service will know about these keys

Returns:

the Uri to call the servlet

Throws:

WcmException - Exception raised in failure situation

getUsermappingServlet

public String getUsermappingServlet(String systemId,
                                    String successUrl,
                                    String failureUrl,
                                    String cancelUrl)
                             throws WcmException

Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getUsermappingPageUri(String, String, String, String)

Returns the URL to a usermapping maintenance servlet

Parameters:

systemId - id of the system

successUrl - URL in case of success

failureUrl - URL in case of failure

cancelUrl - URL in case user cancels

Returns:

The UsermappingServlet value

Throws:

WcmException - Exception raised in failure situation

createLinkToDetailsPageRID

public RID createLinkToDetailsPageRID(RID resourceRID)

Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getResourcePageUri(PathKey, RID, RID) with parameter constant PathKey.DETAILS_PAGE

Returns a URL to navigate to the details-view of a resource. Objects of type IResource can be viewed in a special dialog, showing properties and offering services available for this resource. The returned value consists of the protocol, the host and the details page specified in the configuration of the IURLGenerator instance, e.g. http://myserver:8080/details

Parameters:

resourceRID - the RID of the resource in question

Returns:

the RID to navigate to this page

createLinkToDetailsPageRID

public RID createLinkToDetailsPageRID(RID resourceRID,
                                      RID startRID)

Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getResourcePageUri(PathKey, RID, RID) with parameter constant PathKey.DETAILS_PAGE

Returns a URL to navigate to the details-view of a resource.

Parameters:

resourceRID - The RID of the resource in question

startRID - The RID which is returned as StartPath-parameter

Returns:

the RID to navigate to this page

See Also:

The additional StartUri parameter must be a parent RID of the given resource RID. It forbids a navigation to any element being a root for the given resource RID.

createLinkToExplorerPageRID

public RID createLinkToExplorerPageRID(RID resourceRID)
                                throws WcmException

Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getResourcePageUri(PathKey, RID, RID) with parameter constant PathKey.EXPLORER_PAGE

Returns a URL to navigate to the explorer-view of a collection. Objects of type ICollection can be viewed in a special dialog, showing child resources, navigation information etc. The returned value consists of the protocol, the host and the explorer page specified in the configuration of the IURLGenerator instance, e.g. http://myserver:8080/explorer

Parameters:

resourceRID - The Rid of the resource in question

Returns:

the RID to navigate to this page

Throws:

WcmException - Exception raised in failure situation. Is thrown when resourceRID is null .

createLinkToExplorerPageRID

public RID createLinkToExplorerPageRID(RID resourceRID,
                                       RID startRID)
                                throws WcmException

Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getResourcePageUri(PathKey, RID, RID) with parameter constant PathKey.EXPLORER_PAGE

Returns a URL to navigate to the explorer-view of a collection

Parameters:

resourceRID - The Rid of the resource in question

startRID - The Rid which is returned as StartPath-parameter

Returns:

the RID to navigate to this page

Throws:

WcmException - Exception raised in failure situation. Is thrown when resourceRID is null .

See Also:

The additional StartUri parameter must be a parent RID of the given resource RID. It forbids a navigation to any element being a root for given resource RID. gets RID to show explorer page of resource

getUserResourceRID

public RID getUserResourceRID(com.sapportals.portal.security.usermanagement.IUser user)
                       throws WcmException

Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getUserResourceRID(IUser)

Gets a resource RID representing a user

Parameters:

user - the user to get the RID for

Returns:

The RID to a corresponding user resource

Throws:

WcmException - Exception raised in failure situation

getUserResourceRID

public RID getUserResourceRID(com.sapportals.portal.security.usermanagement.IUser user,
                              String format)
                       throws WcmException

Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getUserResourceRID(IUser, String)

Gets a resource RID representing a user or user information in a specific format

Parameters:

user - the user in question

format - the wanted format

Returns:

The RID to a corresponding user resource

Throws:

WcmException - Exception raised in failure situation

getUserResourceRID

public RID getUserResourceRID(String uid)
                       throws WcmException

Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getUserResourceRID(String)

Gets a resource RID representing a user

Parameters:

uid - the id of the user

Returns:

The RID to a corresponding user resource

Throws:

WcmException - Exception raised in failure situation

getUserResourceRID

public RID getUserResourceRID(String uid,
                              String format)
                       throws WcmException

Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getUserResourceRID(String, String)

Gets a resource URI representing a user or user information in a specific format

Parameters:

uid - the id of the user

format - the format wanted

Returns:

The URI to a corresponding user resource

Throws:

WcmException - Exception raised in failure situation

getGroupResourceRID

public RID getGroupResourceRID(com.sapportals.portal.security.usermanagement.IGroup group)
                        throws WcmException

Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getGroupResourceRID(IGroup)

Gets a resource RID representing a group

Parameters:

group - the group in question

Returns:

The RID to a corresponding group collection resource

Throws:

WcmException - Exception raised in failure situation

getGroupResourceRID

public RID getGroupResourceRID(String gid)
                        throws WcmException

Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getGroupResourceRID(String)

Gets a resource RID representing a group

Parameters:

gid - the id of the group

Returns:

The URI to a corresponding group collection resource

Throws:

WcmException - Exception raised in failure situation

getRoleResourceRID

public RID getRoleResourceRID(com.sapportals.portal.security.usermanagement.IRole role)
                       throws WcmException

Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getRoleResourceRID(IRole)

Gets a resource RID representing a role

Parameters:

role - the role in question

Returns:

The URI to a corresponding role collection resource

Throws:

WcmException - Exception raised in failure situation

getRoleResourceRID

public RID getRoleResourceRID(String rid)
                       throws WcmException

Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getRoleResourceRID(String)

Gets a resource RID representing a role

Parameters:

rid - The id of the role

Returns:

The RID to a corresponding role collection resource

Throws:

WcmException - Exception raised in failure situation

getBusinessCardAppRID

public RID getBusinessCardAppRID(com.sapportals.portal.security.usermanagement.IUser user)
                          throws WcmException

Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getBusinessCardUri(String)

Gets a resource RID for bringing up a business card for a user

Parameters:

user -

Returns:

The RID to a corresponding service

Throws:

WcmException - Exception raised in failure situation

getBusinessCardAppRID

public RID getBusinessCardAppRID(String uid)
                          throws WcmException

Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getBusinessCardUri(String)

Gets a resource RID for bringing up a business card for a user

Parameters:

uid - The id of the user

Returns:

The RID to a corresponding service

Throws:

WcmException - Exception raised in failure situation

replaceURIPlaceholders

public String replaceURIPlaceholders(String uri,
                                     IResourceContext context)
                              throws ResourceException

Deprecated.

Replaces placeholders in URI

Parameters:

uri - the uri to replace the placeholders in

context - the present context of the user who called this method

Returns:

TBD: Description of the outgoing return value

Throws:

ResourceException - Exception raised in failure situation

replaceURIPlaceholders

public String replaceURIPlaceholders(String uri,
                                     IResource resource)
                              throws ResourceException

Deprecated.

Replaces placeholders in URI

Parameters:

uri -

resource -

Returns:

TBD: Description of the outgoing return value

Throws:

ResourceException - Exception raised in failure situation

getUserFolder

public URI getUserFolder(com.sapportals.portal.security.usermanagement.IUser user,
                         String folder)
                  throws WcmException

Deprecated. as of EP 5.0 SP2, replaced by getUserFolderRID(IUser, String)

methods with old URI-interface *********************************************************************************** Gets URI for a folder specified by user context and folder name

Parameters:

user - TBD: Description of the incoming method parameter

folder - TBD: Description of the incoming method parameter

Returns:

the URI to the user/folder combination

Throws:

WcmException - Exception raised in failure situation

getUserHome

public URI getUserHome(com.sapportals.portal.security.usermanagement.IUser user)
                throws WcmException

Deprecated. as of EP 5.0 SP2, replaced by getUserHomeRID(IUser)

Parameters:

user -

Returns:

the URI to the user's home folder

Throws:

WcmException - Exception raised in failure situation

getCompleteURIToShowFolder

public URI getCompleteURIToShowFolder(ICollection folder)
                               throws WcmException

Deprecated. as of EP 5.0 SP2, replaced by getCompleteRIDToShowFolder(ICollection)

Parameters:

folder -

Returns:

a complete URL to put in a mail or on a html-button that will open a webpage, showing the folder and its content, returns NULL, if resource is not a folder Please use createLinkToExplorerPage instead

Throws:

WcmException - Exception raised in failure situation

createServletCall

public URI createServletCall(Properties properties)
                      throws WcmException

Deprecated. as of EP 5.0 SP2, replaced by createServletCallRID(Properties)

creates a complete URL to include in emails etc to start a service

Parameters:

properties - this includes parameters as defined in the IWcmConst.ServiceServletParameters You can also use "free" key-value pairs, but have to make sure, that receiving service will know about these keys creates a complete URL to include in emails etc to start a service

Returns:

the Uri to call the servlet

Throws:

WcmException - Exception raised in failure situation

createLinkToDetailsPage

public URI createLinkToDetailsPage(URI resourceURI)

Deprecated. as of EP 5.0 SP2, replaced by createLinkToDetailsPageRID(RID)

gets URI to show details page of resource

Parameters:

resourceURI -

Returns:

the URI to navigate to this page

createLinkToExplorerPage

public URI createLinkToExplorerPage(URI resourceURI)
                             throws WcmException

Deprecated. as of EP 5.0 SP2, replaced by createLinkToExplorerPageRID(RID)

gets URI to show explorer page of resource

Parameters:

resourceURI -

Returns:

the URI to navigate to this page

Throws:

WcmException - Exception raised in failure situation

getUserResource

public URI getUserResource(com.sapportals.portal.security.usermanagement.IUser user)
                    throws WcmException

Deprecated. as of EP 5.0 SP2, replaced by getUserResourceRID(IUser)

Get a resource URI representing a user

Parameters:

user -

Returns:

The URI to a corresponding user resource

Throws:

WcmException - Exception raised in failure situation

getUserResource

public URI getUserResource(com.sapportals.portal.security.usermanagement.IUser user,
                           String format)
                    throws WcmException

Deprecated. as of EP 5.0 SP2, replaced by getUserResourceRID(IUser, String)

Get a resource RID representing a user or user information in a specific format

Parameters:

user - the user in question

format - the wanted format

Returns:

The RID to a corresponding user resource

Throws:

WcmException - Exception raised in failure situation

getUserResource

public URI getUserResource(String uid)
                    throws WcmException

Deprecated. as of EP 5.0 SP2, replaced by getUserResourceRID(String)

Get a resource URI representing a user

Parameters:

uid -

Returns:

The URI to a corresponding user resource

Throws:

WcmException - Exception raised in failure situation

getUserResource

public URI getUserResource(String uid,
                           String format)
                    throws WcmException

Deprecated. as of EP 5.0 SP2, replaced by getUserResourceRID(String, String)

Get a resource URI representing a user or user information in a specific format

Parameters:

uid - the id of the user

format - the format wanted

Returns:

The URI to a corresponding user resource

Throws:

WcmException - Exception raised in failure situation

getGroupResource

public URI getGroupResource(com.sapportals.portal.security.usermanagement.IGroup group)
                     throws WcmException

Deprecated. as of EP 5.0 SP2, replaced by getGroupResourceRID(IGroup)

Get a resource URI representing a group

Parameters:

group -

Returns:

The URI to a corresponding group collection resource

Throws:

WcmException - Exception raised in failure situation

getGroupResource

public URI getGroupResource(String gid)
                     throws WcmException

Deprecated. as of EP 5.0 SP2, replaced by getGroupResourceRID(String)

Get a resource URI representing a group

Parameters:

gid -

Returns:

The URI to a corresponding group collection resource

Throws:

WcmException - Exception raised in failure situation

getRoleResource

public URI getRoleResource(com.sapportals.portal.security.usermanagement.IRole group)
                    throws WcmException

Deprecated. as of EP 5.0 SP2, replaced by getRoleResourceRID(IRole)

Get a resource URI representing a role

Parameters:

group -

Returns:

The URI to a corresponding role collection resource

Throws:

WcmException - Exception raised in failure situation

getRIDfromWebURL

public RID getRIDfromWebURL(URL webAddress)

Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.mapUri(IUri)

Converts a given web URL in a RID of preset repository manager.

Parameters:

webAddress - a URL object to be converted

Returns:

RID object with converted web url

getRoleResource

public URI getRoleResource(String rid)
                    throws WcmException

Deprecated. as of EP 5.0 SP2, replaced by getRoleResourceRID(String)

Get a resource URI representing a role

Parameters:

rid -

Returns:

The URI to a corresponding role collection resource

Throws:

WcmException - Exception raised in failure situation

getBusinessCardApp

public URI getBusinessCardApp(com.sapportals.portal.security.usermanagement.IUser user)
                       throws WcmException

Deprecated. as of EP 5.0 SP2, replaced by getBusinessCardAppRID(IUser)

Get a resource URI for bringing up a business card for a user

Parameters:

user -

Returns:

The URI to a corresponding service

Throws:

WcmException - Exception raised in failure situation

getBusinessCardApp

public URI getBusinessCardApp(String uid)
                       throws WcmException

Deprecated. as of EP 5.0 SP2, replaced by getBusinessCardAppRID(String)

Get a resource URI for bringing up a business card for a user

Parameters:

uid -

Returns:

The URI to a corresponding service

Throws:

WcmException - Exception raised in failure situation