Class finesse.restservices.SystemInfo
Extends
finesse.restservices.RestBase.
JavaScript representation of a SystemInfo object.
Defined in: finesse.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
- Fields borrowed from class finesse.restservices.RestBase:
- restResponseStatus
| Method Attributes | Method Name and Description |
|---|---|
|
getAlternateHost(arguments)
Checks all arguments against the primary and secondary hosts (FQDN) and returns the other node.
|
|
|
Returns the current timestamp from this SystemInfo object.
|
|
|
Getter for the deployment type (UCCE or UCCX).
|
|
|
Gets the license.
|
|
|
Gets the peripheral ID that Finesse is connected to.
|
|
|
Returns the status of the Finesse system.
|
|
|
Returns the reason due to which Finesse is OUT OF SERVICE.
|
|
|
Gets the systemAuthMode for the current deployment
|
|
|
Checks all arguments against the primary and secondary hosts (FQDN) and returns the match.
|
|
|
Getter for the xmpp domain of the system.
|
|
|
Getter for the xmpp pubsub domain of the system.
|
|
|
Returns whether this is a single node deployment or not by checking for the existence of the secondary node in SystemInfo.
|
- Methods borrowed from class finesse.restservices.RestBase:
- addHandler, getData, getId, getProperty, hasProperty, isLoaded, refresh, removeHandler
Method Detail
{String}
getAlternateHost(arguments)
Checks all arguments against the primary and secondary hosts (FQDN) and returns the other node.
This is useful for getting the FQDN of the other Finesse server, i.e. for failover purposes.
- Parameters:
- {String} arguments
- - any number of arguments to match against
- Returns:
- {String} FQDN (if properly configured) of the alternate node, defaults to primary if no match is found, undefined for single node deployments.
{String}
getCurrentTimestamp()
Returns the current timestamp from this SystemInfo object.
This is used to calculate time drift delta between server and client.
- Returns:
- {String} Time (GMT): yyyy-MM-dd'T'HH:mm:ss'Z'
{String}
getDeploymentType()
Getter for the deployment type (UCCE or UCCX).
- Returns:
- {String} "UCCE" or "UCCX"
{String}
getlicense()
Gets the license. Only apply to UCCX.
- Returns:
- {String} The license if UCCX, or empty string otherwise.
{String}
getPeripheralId()
Gets the peripheral ID that Finesse is connected to. The peripheral
ID is the ID of the PG Routing Client (PIM).
- Returns:
- {String} The peripheral Id if UCCE, or empty string otherwise.
{finesse.restservices.SystemInfo.Statuses}
getStatus()
Returns the status of the Finesse system.
IN_SERVICE if the Finesse API reports that it is in service,
OUT_OF_SERVICE otherwise.
- Returns:
- {finesse.restservices.SystemInfo.Statuses} System Status
{String}
getStatusReason()
Returns the reason due to which Finesse is OUT OF SERVICE.
It returns empty string when Finesse status is IN_SERVICE.
- Returns:
- {String} statusReason if finesse is OUT OF SERVICE , or empty string otherwise.
{String}
getSystemAuthMode()
Gets the systemAuthMode for the current deployment
- Returns:
- {String} The System auth mode for current deployment
{String}
getThisHost()
Checks all arguments against the primary and secondary hosts (FQDN) and returns the match.
This is useful for getting the FQDN of the current Finesse server.
- Parameters:
- {String} ...arguments[]...
- - any number of arguments to match against
- Returns:
- {String} FQDN (if properly configured) of the matched host of the primary or secondary node, or undefined if no match is found.
{String}
getXmppDomain()
Getter for the xmpp domain of the system.
- Returns:
- {String} The xmpp domain corresponding to this SystemInfo object.
{String}
getXmppPubSubDomain()
Getter for the xmpp pubsub domain of the system.
- Returns:
- {String} The xmpp pubsub domain corresponding to this SystemInfo object.
{Boolean}
isSingleNode()
Returns whether this is a single node deployment or not by checking for the existence of the secondary node in SystemInfo.
- Returns:
- {Boolean} True for single node deployments, false otherwise.