Click or drag to resize

XServerUrl Class

Helper class for converting URL address into the correct format.
Inheritance Hierarchy
SystemObject
  Ptv.XServer.Controls.Map.ToolsXServerUrl

Namespace:  Ptv.XServer.Controls.Map.Tools
Assembly:  Ptv.XServer.Controls.Map (in Ptv.XServer.Controls.Map.dll) Version: 1.7.10.0
Syntax
public static class XServerUrl

The XServerUrl type exposes the following members.

Methods
  NameDescription
Public methodStatic memberComplete
To access the functionality provided by the XServer's web services, a URL has to be specified, which has to fulfill some constraints.

At first, according to the concrete xServer (for example xMap), the URL has to look like (scheme)://(host):(port)/xmap/ws/XMap, especially the path with its mixed uppercase and lower case characters. If no scheme is specified in the input URL, then a completion is started, concerning an adequate value for this scheme, a check for an xServer internet deployed XServer and eventually insertion of the default port, if no one is specifed in the input URL.

If the scheme (or protocol) like http is missing in the URL, then this method examines the host for an xServer internet-like name. The host indicates an Azure XServer, if it contains some characters followed by a '-', followed by one of the letters 'h', 'n' or 't'. Optionally, the module name may precede this construct, and the texts '-test' or '-integration' may follow also optionally. The path is completely ignored. The scheme is set to https, if an xServer internet host name is detected, otherwise http is used. The following URLs will all be transformed to https://xmap-eu-n.cloud.ptvgroup.com/xmap/ws/XMap : eu-n, xmap-eu-n, eu-n.cloud.ptvgroup.com xmap-eu-n.cloud.ptvgroup.com

If a port is part of the URL, it will be used, except an xServer internet host is detected (then the port is completely ignored). If no scheme and no port is specified (and no xServer internet host is detected), then a default port-assignment is used.

Public methodStatic memberIsDecartaBackend
Checks if the provided URL addresses uses a DeCarta backend.
Public methodStatic memberIsXServerInternet
Checks if the provided URL address is an XServer deployed in an XServer Internet environment.
Public methodStatic memberPort
Matches a module name to the corresponding port. For example, 'xmap' results in a return value of 50010, which represents the default port number, commonly used for XMap.
Top
See Also