com.sap.tc.webdynpro.services.sal.url.api

Interface IWDURLGenerator

All Superinterfaces:

IWDService

public interface IWDURLGenerator

extends IWDService

IWDURLGenerator defines the Web Dynpro URL generation service. This service should be used to generated URLs for any IWDWebResource objects that are referenced by Web Dynpro applications.
The interface provides methods which are responsible for the following:

• Get the real public resource path, independent of a deployable object and deployable object part
• Get the real public resource path on the level of a deployable object
• Get the real public resource path on the level of a deployable object part
• Get the URL of a specified web resource that is defined on the level of a deployable object
• Get the URL of a specified web resource that is defined on the level of a deployable object part

See Also:

WDURLGenerator

Type Classification:

This interface is part of the Web Dynpro API, so applications may reference it or call any method of it, but they must not implement or extend it.

For a detailed explanation of API classification see the Web Dynpro Compatibility Guide

Method Summary

String	getAbsoluteWebResourceURL(String objectName) Deprecated. This method has been deprecated: the usage of absolute URLs is not recommended since absolute URLs won't work in system landscapes with e.g. reverse proxies or Web dispatchers. Use getWebResourceURL(String) instead. The method may be withdrawn with the first new NetWeaver release in 2006.
String	getAbsoluteWebResourceURL(String objectName, String resourceName) Deprecated. This method has been deprecated: the usage of absolute URLs is not recommended since absolute URLs won't work in system landscapes with e.g. reverse proxies or Web dispatchers. Use getWebResourceURL(String, String) instead. The method may be withdrawn with the first new NetWeaver release in 2006.
String	getAbsoluteWebResourceURL(WDDeployableObjectPart deployableObjectPart) Deprecated. This method has been deprecated: the usage of absolute URLs is not recommended since absolute URLs won't work in system landscapes with e.g. reverse proxies or Web dispatchers. Use getWebResourceURL(WDDeployableObjectPart) instead. The method may be withdrawn with the first new NetWeaver release in 2006.
String	getAbsoluteWebResourceURL(WDDeployableObjectPart deployableObjectPart, String resourceName) Deprecated. This method has been deprecated: the usage of absolute URLs is not recommended since absolute URLs won't work in system landscapes with e.g. reverse proxies or Web dispatchers. Use getWebResourceURL(WDDeployableObjectPart, String) instead. The method may be withdrawn with the first new NetWeaver release in 2006.
String	getApplicationURL(String deployableObjectName, String applicationPartName)
String	getApplicationURL(String objectName, String partName, Map urlParameters)
String	getApplicationURL(WDDeployableObjectPart deployableObjectPart)
String	getApplicationURL(WDDeployableObjectPart deployableObjectPart, Map urlParameters)
String	getDynamicApplicationURL(String deployableObjectName, String applicationPartName)
String	getDynamicApplicationURL(WDDeployableObjectPart deployableObjectPart)
String	getPortalIconsResourcePath()
String	getPortalIconsWebResourcePath() Deprecated. Starting with NetWeaver 04s, Web Dynpro supports WSRP and generates URLs in which the URL to a MIME object is embedded in a WSRP URL. With these URLs, it is no longer possible to append a relative URL path to the computed URL prefix. Use the getPortalIconWebResourcePath(String) method instead. The method may be withdrawn with the first new NetWeaver release in 2006.
String	getPortalIconWebResourcePath(String iconName)
String	getPublicResourcePath(String resourceName)
String	getPublicResourcePath(WDDeployableObjectPart part, String resourceName)
String	getResourcePath() Deprecated. Method will throw a java.lang.UnsupportedOperationException in the next release after NetWeaver 04. Use getResourcePath(String) instead. The method may be withdrawn with the first new NetWeaver release in 2006.
String	getResourcePath(String objectName)
String	getResourcePath(String objectName, String resourceName)
String	getResourcePath(WDDeployableObjectPart deployableObjectPart)
String	getResourcePath(WDDeployableObjectPart deployableObjectPart, String resourceName)
String	getSAPIconsResourcePath()
String	getSAPIconsWebResourcePath() Deprecated. Starting with NetWeaver 04s, Web Dynpro supports WSRP and generates URLs in which the URL to a MIME object is embedded in a WSRP URL. With these URLs, it is no longer possible to append a relative URL path to the computed URL prefix. Use the getSAPIconWebResourcePath(String) method instead. The method may be withdrawn with the first new NetWeaver release in 2006.
String	getSAPIconWebResourcePath(String iconName)
String	getStaticApplicationURL()
String	getWebResourcePath() Deprecated. Starting with NetWeaver 04s, Web Dynpro supports WSRP and generates URLs in which the URL to a MIME object is embedded in a WSRP URL. With these URLs, it is no longer possible to append a relative URL path to the computed URL prefix. Use the getWebResourcePath methods which take a relative path to the MIME object as input parameter instead. The method may be withdrawn with the first new NetWeaver release in 2006.
String	getWebResourcePath(String objectName) Deprecated. Starting with NetWeaver 04s, Web Dynpro supports WSRP and generates URLs in which the URL to a MIME object is embedded in a WSRP URL. With these URLs, it is no longer possible to append a relative URL path to the computed URL prefix. Use the getWebResourcePath methods which take a relative path to the MIME object as input parameter instead. The method may be withdrawn with the first new NetWeaver release in 2006.
String	getWebResourcePath(WDDeployableObjectPart deployableObjectPart) Deprecated. Starting with NetWeaver 04s, Web Dynpro supports WSRP and generates URLs in which the URL to a MIME object is embedded in a WSRP URL. With these URLs, it is no longer possible to append a relative URL path to the computed URL prefix. Use the getWebResourcePath methods which take a relative path to the MIME object as input parameter instead. The method may be withdrawn with the first new NetWeaver release in 2006.
String	getWebResourceURL(String objectName) Deprecated. Starting with NetWeaver 04s, Web Dynpro supports WSRP and generates URLs in which the URL to a MIME object is embedded in a WSRP URL. With these URLs, it is no longer possible to append a relative URL path to the computed URL prefix. Use the getWebResourcePath methods which take a relative path to the MIME object as input parameter instead. The method may be withdrawn with the first new NetWeaver release in 2006.
String	getWebResourceURL(String objectName, String resourceName)
String	getWebResourceURL(WDDeployableObjectPart deployableObjectPart) Deprecated. Starting with NetWeaver 04s, Web Dynpro supports WSRP and generates URLs in which the URL to a MIME object is embedded in a WSRP URL. With these URLs, it is no longer possible to append a relative URL path to the computed URL prefix. Use the getWebResourcePath methods which take a relative path to the MIME object as input parameter instead. The method may be withdrawn with the first new NetWeaver release in 2006.
String	getWebResourceURL(WDDeployableObjectPart deployableObjectPart, String resourceName)
String	getWebResourceURLForPath(String relativePath)
String	getWorkloadBalancedApplicationURL(String deployableObjectName, String applicationPartName)
String	getWorkloadBalancedApplicationURL(String objectName, String partName, Map urlParameters)
String	getWorkloadBalancedApplicationURL(WDDeployableObjectPart deployableObjectPart)
String	getWorkloadBalancedApplicationURL(WDDeployableObjectPart deployableObjectPart, Map urlParameters)

Methods inherited from interface com.sap.tc.webdynpro.services.sal.api.IWDService

getDescription, getServiceName, getVersion

Method Detail

getPublicResourcePath

public String getPublicResourcePath(String resourceName)

See Also:

WDURLGenerator.getPublicResourcePath(String)

getPublicResourcePath

public String getPublicResourcePath(WDDeployableObjectPart part,
                                    String resourceName)

See Also:

WDURLGenerator.getPublicResourcePath(WDDeployableObjectPart, String)

getResourcePath

public String getResourcePath()

Deprecated. Method will throw a java.lang.UnsupportedOperationException in the next release after NetWeaver 04. Use getResourcePath(String) instead. The method may be withdrawn with the first new NetWeaver release in 2006.

See Also:

WDURLGenerator.getResourcePath()

getResourcePath

public String getResourcePath(String objectName)

See Also:

WDURLGenerator.getResourcePath(String)

getResourcePath

public String getResourcePath(String objectName,
                              String resourceName)

See Also:

WDURLGenerator.getResourcePath(String, String)

getResourcePath

public String getResourcePath(WDDeployableObjectPart deployableObjectPart)

See Also:

WDURLGenerator.getResourcePath(WDDeployableObjectPart)

getResourcePath

public String getResourcePath(WDDeployableObjectPart deployableObjectPart,
                              String resourceName)
                       throws WDAliasResolvingException

Throws:

WDAliasResolvingException

See Also:

WDURLGenerator.getResourcePath(WDDeployableObjectPart, String)

getWebResourcePath

public String getWebResourcePath()

Deprecated. Starting with NetWeaver 04s, Web Dynpro supports WSRP and generates URLs in which the URL to a MIME object is embedded in a WSRP URL. With these URLs, it is no longer possible to append a relative URL path to the computed URL prefix. Use the getWebResourcePath methods which take a relative path to the MIME object as input parameter instead. The method may be withdrawn with the first new NetWeaver release in 2006.

See Also:

WDURLGenerator.getWebResourcePath()

getWebResourcePath

public String getWebResourcePath(String objectName)

Deprecated. Starting with NetWeaver 04s, Web Dynpro supports WSRP and generates URLs in which the URL to a MIME object is embedded in a WSRP URL. With these URLs, it is no longer possible to append a relative URL path to the computed URL prefix. Use the getWebResourcePath methods which take a relative path to the MIME object as input parameter instead. The method may be withdrawn with the first new NetWeaver release in 2006.

See Also:

WDURLGenerator.getWebResourcePath(String)

getWebResourcePath

public String getWebResourcePath(WDDeployableObjectPart deployableObjectPart)

Deprecated. Starting with NetWeaver 04s, Web Dynpro supports WSRP and generates URLs in which the URL to a MIME object is embedded in a WSRP URL. With these URLs, it is no longer possible to append a relative URL path to the computed URL prefix. Use the getWebResourcePath methods which take a relative path to the MIME object as input parameter instead. The method may be withdrawn with the first new NetWeaver release in 2006.

See Also:

WDURLGenerator.getWebResourcePath(WDDeployableObjectPart)

getWebResourceURL

public String getWebResourceURL(String objectName,
                                String resourceName)
                         throws WDURLException

Throws:

WDURLException

See Also:

WDURLGenerator.getWebResourceURL(String, String)

getWebResourceURL

public String getWebResourceURL(String objectName)
                         throws WDURLException

Deprecated. Starting with NetWeaver 04s, Web Dynpro supports WSRP and generates URLs in which the URL to a MIME object is embedded in a WSRP URL. With these URLs, it is no longer possible to append a relative URL path to the computed URL prefix. Use the getWebResourcePath methods which take a relative path to the MIME object as input parameter instead. The method may be withdrawn with the first new NetWeaver release in 2006.

Throws:

WDURLException

See Also:

WDURLGenerator.getWebResourceURL(String)

getWebResourceURL

public String getWebResourceURL(WDDeployableObjectPart deployableObjectPart,
                                String resourceName)
                         throws WDURLException

Throws:

WDURLException

See Also:

WDURLGenerator.getWebResourceURL(WDDeployableObjectPart, String)

getWebResourceURL

public String getWebResourceURL(WDDeployableObjectPart deployableObjectPart)
                         throws WDURLException

Deprecated. Starting with NetWeaver 04s, Web Dynpro supports WSRP and generates URLs in which the URL to a MIME object is embedded in a WSRP URL. With these URLs, it is no longer possible to append a relative URL path to the computed URL prefix. Use the getWebResourcePath methods which take a relative path to the MIME object as input parameter instead. The method may be withdrawn with the first new NetWeaver release in 2006.

Throws:

WDURLException

See Also:

WDURLGenerator.getWebResourceURL(WDDeployableObjectPart)

getWebResourceURLForPath

public String getWebResourceURLForPath(String relativePath)
                                throws WDURLException

Throws:

WDURLException

See Also:

WDURLGenerator.getWebResourceURLForPath(String)

getAbsoluteWebResourceURL

public String getAbsoluteWebResourceURL(String objectName,
                                        String resourceName)
                                 throws WDURLException

Deprecated. This method has been deprecated: the usage of absolute URLs is not recommended since absolute URLs won't work in system landscapes with e.g. reverse proxies or Web dispatchers. Use getWebResourceURL(String, String) instead. The method may be withdrawn with the first new NetWeaver release in 2006.

Throws:

WDURLException

See Also:

WDURLGenerator.getAbsoluteWebResourceURL(String, String)

getAbsoluteWebResourceURL

public String getAbsoluteWebResourceURL(String objectName)
                                 throws WDURLException

Deprecated. This method has been deprecated: the usage of absolute URLs is not recommended since absolute URLs won't work in system landscapes with e.g. reverse proxies or Web dispatchers. Use getWebResourceURL(String) instead. The method may be withdrawn with the first new NetWeaver release in 2006.

Throws:

WDURLException

See Also:

WDURLGenerator.getAbsoluteWebResourceURL(String)

getAbsoluteWebResourceURL

public String getAbsoluteWebResourceURL(WDDeployableObjectPart deployableObjectPart,
                                        String resourceName)
                                 throws WDURLException

Deprecated. This method has been deprecated: the usage of absolute URLs is not recommended since absolute URLs won't work in system landscapes with e.g. reverse proxies or Web dispatchers. Use getWebResourceURL(WDDeployableObjectPart, String) instead. The method may be withdrawn with the first new NetWeaver release in 2006.

Throws:

WDURLException

See Also:

WDURLGenerator.getAbsoluteWebResourceURL(WDDeployableObjectPart, String)

getAbsoluteWebResourceURL

public String getAbsoluteWebResourceURL(WDDeployableObjectPart deployableObjectPart)
                                 throws WDURLException

Deprecated. This method has been deprecated: the usage of absolute URLs is not recommended since absolute URLs won't work in system landscapes with e.g. reverse proxies or Web dispatchers. Use getWebResourceURL(WDDeployableObjectPart) instead. The method may be withdrawn with the first new NetWeaver release in 2006.

Throws:

WDURLException

See Also:

WDURLGenerator.getAbsoluteWebResourceURL(WDDeployableObjectPart)

getApplicationURL

public String getApplicationURL(WDDeployableObjectPart deployableObjectPart)
                         throws WDURLException

Throws:

WDURLException

See Also:

WDURLGenerator.getApplicationURL(WDDeployableObjectPart)

getApplicationURL

public String getApplicationURL(String deployableObjectName,
                                String applicationPartName)
                         throws WDURLException

Throws:

WDURLException

See Also:

WDURLGenerator.getApplicationURL(String, String)

getDynamicApplicationURL

public String getDynamicApplicationURL(String deployableObjectName,
                                       String applicationPartName)
                                throws WDURLException

Throws:

WDURLException

getDynamicApplicationURL

public String getDynamicApplicationURL(WDDeployableObjectPart deployableObjectPart)
                                throws WDURLException

Throws:

WDURLException

getStaticApplicationURL

public String getStaticApplicationURL()

getWorkloadBalancedApplicationURL

public String getWorkloadBalancedApplicationURL(String deployableObjectName,
                                                String applicationPartName)
                                         throws WDURLException

Throws:

WDURLException

See Also:

WDURLGenerator.getWorkloadBalancedApplicationURL(String, String)

getWorkloadBalancedApplicationURL

public String getWorkloadBalancedApplicationURL(WDDeployableObjectPart deployableObjectPart)
                                         throws WDURLException

Throws:

WDURLException

See Also:

WDURLGenerator.getWorkloadBalancedApplicationURL(WDDeployableObjectPart)

getApplicationURL

public String getApplicationURL(WDDeployableObjectPart deployableObjectPart,
                                Map urlParameters)
                         throws WDURLException

Throws:

WDURLException

See Also:

WDURLGenerator.getApplicationURL(WDDeployableObjectPart, java.util.Map)

getApplicationURL

public String getApplicationURL(String objectName,
                                String partName,
                                Map urlParameters)
                         throws WDURLException

Throws:

WDURLException

See Also:

WDURLGenerator.getApplicationURL(String, String, java.util.Map)

getWorkloadBalancedApplicationURL

public String getWorkloadBalancedApplicationURL(WDDeployableObjectPart deployableObjectPart,
                                                Map urlParameters)
                                         throws WDURLException

Throws:

WDURLException

See Also:

WDURLGenerator.getWorkloadBalancedApplicationURL(WDDeployableObjectPart, java.util.Map)

getWorkloadBalancedApplicationURL

public String getWorkloadBalancedApplicationURL(String objectName,
                                                String partName,
                                                Map urlParameters)
                                         throws WDURLException

Throws:

WDURLException

See Also:

WDURLGenerator.getWorkloadBalancedApplicationURL(String, String, java.util.Map)

getSAPIconsResourcePath

public String getSAPIconsResourcePath()

See Also:

WDURLGenerator.getSAPIconsResourcePath()

getSAPIconsWebResourcePath

public String getSAPIconsWebResourcePath()

Deprecated. Starting with NetWeaver 04s, Web Dynpro supports WSRP and generates URLs in which the URL to a MIME object is embedded in a WSRP URL. With these URLs, it is no longer possible to append a relative URL path to the computed URL prefix. Use the getSAPIconWebResourcePath(String) method instead. The method may be withdrawn with the first new NetWeaver release in 2006.

See Also:

WDURLGenerator.getSAPIconsWebResourcePath()

getSAPIconWebResourcePath

public String getSAPIconWebResourcePath(String iconName)

See Also:

WDURLGenerator.getSAPIconWebResourcePath(String)

getPortalIconsResourcePath

public String getPortalIconsResourcePath()

See Also:

WDURLGenerator.getPortalIconsResourcePath()

getPortalIconsWebResourcePath

public String getPortalIconsWebResourcePath()

Deprecated. Starting with NetWeaver 04s, Web Dynpro supports WSRP and generates URLs in which the URL to a MIME object is embedded in a WSRP URL. With these URLs, it is no longer possible to append a relative URL path to the computed URL prefix. Use the getPortalIconWebResourcePath(String) method instead. The method may be withdrawn with the first new NetWeaver release in 2006.

See Also:

WDURLGenerator.getPortalIconsWebResourcePath()

getPortalIconWebResourcePath

public String getPortalIconWebResourcePath(String iconName)

See Also:

WDURLGenerator.getPortalIconWebResourcePath(String)