net~ LocationDatumUrlHelper

The environment associated with this helper.

Get a parameters object that can be used to hold URL variables.

Get the base URL to the REST API.

This implementation is a stub, meant for subclasses to override. This implementation simply returns module:net~UrlHelper#hostUrl.

Get or set an environment parameter.

This is a shortcut for calling module:net~Configuration#value on the environment object.

Get a URL for just the SolarNet host, without any path.

This method constructs an absolute URL based on the following properties configured on this instance's module:net~Environment:

1. If environment.useTls() returns true then use HTTPS as the protocol, otherwise HTTP.
2. Use host for the host name or IP address, unless proxyHost is available.
3. Use port for the port, unless proxyPort is available. If neither are available, use 443 for HTTPS or 80 for HTTP.

Get a URL for just the SolarNet host using the WebSocket protocol, without any path.

This method constructs an absolute URL based on the following properties configured on this instance's module:net~Environment:

1. If environment.useTls() returns true then use WSS as the protocol, otherwise WS.
2. Use host for the host name or IP address, unless proxyHost is available.
3. Use port for the port, unless proxyPort is available. If neither are available, use 443 for WSS or 80 for WS.

Get or set a parameter.

This is a shortcut for calling module:net~Configuration#value on the parameters object.

Replace occurances of URL template variables with values from the parameters property and append to the host URL.

This method provides a way to resolve an absolute URL based on the configured environment and parameters on this object.

Replace occurances of URL template variables with values from the parameters property.

URL template variables are specified as {<em>name</em>}. The variable will be replaced by the value associated with property name in the parameters object. The value will be URI encoded.