dw.web
Class URL
Object
dw.web.URL
Represents a URL in Commerce Cloud Digital.
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
abs() : URL
Makes the URL absolute and ensures that the protocol of the request is used or http in a mail context.
append(name : String, value : String) : URL
Append a request parameter to this URL.
appendCSRFTokenBM() : URL

Appends, if applicable, a CSRF protection token to this URL.

host(host : String) : URL
Updates the URL with the specified host name Note: This method is not applicable for static content or image transformation URLs.
http() : URL
Makes the URL absolute and ensures that the protocol http is used.
https() : URL
Makes the URL absolute and ensures that the protocol https is used.
relative() : URL
Makes the URL relative.
remove(name : String) : URL
Remove a request parameter from this URL.
siteHost() : URL
Updates the URL with the site host name Note: This method is not applicable for static content or image transformation URLs.
toString() : String
Return String representation of the URL.
Methods inherited from class Object
Method Detail
abs
abs() : URL
Makes the URL absolute and ensures that the protocol of the request is used or http in a mail context. Note: This method is not applicable for static content or image transformation URLs. In this case a runtime exception is thrown.
Returns:
A new URL instance.

append
append(name : String, value : String) : URL
Append a request parameter to this URL.
Parameters:
name - The parameter name. Must not be null.
value - The parameter value. If null, then treated as empty value.
Returns:
A reference to this URL.

appendCSRFTokenBM
appendCSRFTokenBM() : URL

Appends, if applicable, a CSRF protection token to this URL. The CSRF token will only be appended under the following conditions:

  • the URL is a pipeline URL
  • the URL is for Business Manager
  • CSRF validation is not disabled

If a CSRF token already exists in the URL, it will be replaced with a newly generated one.

Returns:
a reference to this URL, with a CSRF token appended if applicable.

host
host(host : String) : URL
Updates the URL with the specified host name Note: This method is not applicable for static content or image transformation URLs. In this case a runtime exception is thrown.
Parameters:
host - The host name that is used to update the URL.
Returns:
A new URL instance.

http
http() : URL
Makes the URL absolute and ensures that the protocol http is used. Note: This method is not applicable for static content or image transformation URLs. In this case a runtime exception is thrown.
Returns:
A new URL instance.

https
https() : URL
Makes the URL absolute and ensures that the protocol https is used. Note: This method is not applicable for static content or image transformation URLs. In this case a runtime exception is thrown.
Returns:
A new URL instance.

relative
relative() : URL
Makes the URL relative. Note: This method is not applicable for static content or image transformation URLs. In this case a runtime exception is thrown.
Returns:
A new URL instance.

remove
remove(name : String) : URL
Remove a request parameter from this URL. If the parameter is not part of the URL, nothing is done.
Parameters:
name - The parameter name. Must not be null.
Returns:
A reference to this URL.

siteHost
siteHost() : URL
Updates the URL with the site host name Note: This method is not applicable for static content or image transformation URLs. In this case a runtime exception is thrown.
Returns:
A new URL instance.

toString
toString() : String
Return String representation of the URL.
Returns:
the URL as a string.