Raritan Computer CC-WSAPI-0B-v5.1.0-E Marine Radio User Manual


 
Chapter 2: API Definitions
12
URLObject
Components to form a URL to access the CC-SG.
Elements
String protocol - the protocol used - either http or https
String port - the TCP port to be used for connecting to the
interface: port 80 or port 443.
String path - the path to the actual webservice servlet
String tokenKey - the name of the property to be used for the
token. The value is always “sessionID”
String tokenValue - the actual property value corresponding to
the tokenKey from above
Constructing a URL from URLObject
Combine the string elements of the returned URLObject (italicized) in the
following order with other data (plain):
protocol + :// + CCSG Address + : + port + path + ? + tokenKey + = +
tokenValue
Given the following URLObject data:
protocol - http
port - 80
path - /CommandCenterWeb/index_frames.jsp
tokenKey - sessionID
tokenValue - 03AC4A3B1EE2CB665564BEB1ACAA8401
The constructed URL should look similar to this one:
http://10.0.0.101:80/CommandCenterWeb/index_frames.jsp?sessionID=
03AC4A3B1EE2CB665564BEB1ACAA8401
Note: A single question mark (?) delimits parameters from the document
path. Parameters themselves are separated from one another using an
ampersand (&). The path from getInterfaceURL() will already contain
parameters, so you must append the sessionID using an ampersand
delimiter in that case.
NodeManagementException
Exception returned for all errors specific to node management.