Class SolarSshApi

Create an instruction auth builder for pre-signing the terminal connect request.

The returned builder will be configured for a GET request using the viewNodeMetadataUrl() URL.

Create an instruction auth builder for pre-signing the create session request.

The returned builder will be configured for a GET request using the viewPendingInstructionsUrl() URL.

Generate a URL for creating a new SolarSSH session.

Get a new DatumFilter configured with parameters of this instance.

This will look for the following parameters:

• nodeIds
• sourceIds

Get an environment parameter.

This is a shortcut for calling Util.Configuration#value on the environment object.

Set an environment parameter.

This is a shortcut for calling Util.Configuration#value on the environment object.

Get a URL for just the SolarNet host, without any path to be used for actual requests.

Calls the toRequestUrl() with hostUrl() as the argument.

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 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.
3. Use port for the port if available and not the standard 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 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.
3. Use port for the port if available and not the standard 443 for WSS or 80 for WS.

Get the URL to the SolarSSH HTTP proxy to the configured SolarNode.

Get a parameter, with plural suffix array support.

This method will first look for a parameter named exactly key, and if found return that. Otherwise it will look for an array parameter named key with s appended, and if found return the first element from that array. For example:

const helper = new UrlHelper();
helper.parameter('nodeIds', [1, 2, 3]);

helper.param('nodeIds'); // [1, 2, 3]
helper.param('nodeId');  // 1
Copy

If key already ends in s, then a desired array result is assumed. If a value is not found for the parameter, then s is removed from key and that parameter value is returned, as an array if it is not already. For example:

const helper = new UrlHelper();
helper.parameter('nodeId', 1);

helper.param('nodeIds'); // [1]
helper.param('nodeId');  // 1
Copy

Get a parameter.

This is a shortcut for calling Util.Configuration#value on the parameters object.

Set a parameter.

This is a shortcut for calling Util.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.

Create an instruction auth builder for pre-signing the start session request.

The returned builder will be configured for a POST request using the queueInstructionUrl() URL with the StartRemoteSsh instruction.

Generate a URL for starting a SolarSSH session.

Create an instruction auth builder for pre-signing the stop session request.

The returned builder will be configured for a POST request using the queueInstructionUrl() URL with the StopRemoteSsh instruction.

Generate a URL for stopping a SolarSSH session.

Get the URL to the SolarSSH WebSocket termainl connection for a SolarNode.

Get the URL to actually request, incorporating the environment's proxyUrlPrefix if available.

If a environment.proxyUrlPrefix value is configured, this will re-write the URL to use that host prefix, otherwise url will be returned unchanged.

Create an instruction auth builder for signing the request to view the StartRemoteSsh instruction.

The returned builder will be configured with the same URL returned from Net.SolarSshApi#viewStartRemoteSshInstructionUrl.

Generate a URL for viewing the StartRemoteSsh instruction.

Create an instruction auth builder for signing the request to view the StopRemoteSsh instruction.

The returned builder will be configured with the same URL returned from Net.SolarSshApi#viewStopRemoteSshInstructionUrl.

Generate a URL for viewing the StopRemoteSsh instruction.

Generate a URL to get information about the requesting authenticated user.

Replace occurances of URL template variables with values from a parameter object.

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

Any occurances of // after replacing template variables will be reduced to /.