7 Common parameter type definitions ToC Previous Next

7.27 RegisteredServer ToC Previous Next

The components of this parameter are defined in Table 169.

Table 169 – RegisteredServer

Name Type Description
RegisteredServer structure The Server to register.
   serverUri String The globally unique identifier for the Server instance. The serverUri matches the applicationUri from the ApplicationDescription defined in 7.1.
   productUri String The globally unique identifier for the Server product.
   serverNames [] LocalizedText A list of localized descriptive names for the Server.
The list shall have at least one valid entry.
   serverType Enum
ApplicationType
The type of application.
The enumeration values are defined in Table 112.
The value “CLIENT_1” (The application is a Client) is not allowed. The Service result shall be Bad_InvalidArgument in this case.
   gatewayServerUri String The URI of the Gateway Server associated with the discoveryUrls.
This value is only specified by Gateway Servers that wish to register the Servers that they provide access to.
For Servers that do not act as a Gateway Server this parameter shall be null.
   discoveryUrls [] String A list of DiscoveryEndpoints for the Server.
The list shall have at least one valid entry.
   semaphoreFilePath String The path to the semaphore file used to identify an automatically-launched Server instance; Manually-launched servers will not use this parameter.
If a Semaphore file is provided, the isOnline flag is ignored.
If a Semaphore file is provided and exists, the LocalDiscoveryServer shall save the registration information in a persistent data store that it reads whenever the LocalDiscoveryServer starts.
If a Semaphore file is specified but does not exist the Discovery Server shall remove the registration from any persistent data store.
If the Server has registered with a semaphoreFilePath, the Discovery Server shall check that this file exists before returning the ApplicationDescription to the client.
If the Server did not register with a semaphoreFilePath (it is null or empty) then the Discovery Server does not attempt to verify the existence of the file before returning the ApplicationDescription to the client.
   isOnline Boolean True if the Server is currently able to accept connections from Clients. The Discovery Server shall return ApplicationDescriptions to the Client.
The Server is expected to periodically re-register with the Discovery Server.
False if the Server is currently unable to accept connections from Clients. The Discovery Server shall NOT return ApplicationDescriptions to the Client.
This parameter is ignored if a semaphoreFilePath is provided.

Previous Next