Configuring the server HTTP Endpoint

The server supports both HTTP and HTTPS connections but by default is HTTPS only. It is possible to enable, disable, and change the ports that are used by both HTTP and HTTPS server connections.

About this task

If you want to configure what port the server is accessible on and whether HTTP or HTTPS is used, follow these steps.

Procedure

  1. Open HCL Quality Server installation directory\config\server.custom.xml in a text editor.
  2. Uncomment the example httpEndpoint element.
    <httpEndpoint id="defaultHttpEndpoint" 
                            httpPort="7819"  
                            httpsPort="5443" />
    Note: If this element is missing, it can be copied from HCL Quality Server installation directory\usr\servers\defaultServer\server.generated.xml.
  3. For plain HTTP communication set the httpPort attribute to a valid port, for example 7819. To disable plain HTTP set the httpPort attribute to -1.
    Note: You must explicitly set the port to -1 rather than delete the httpPort attribute as deleting the attribute causes the httpPort value found in HCL Quality Server installation directory\usr\server\defaultServer\server.generated.xml to be used instead.
  4. For HTTPS communication set the httpsPort attribute to a valid port, for example 5443. To disable HTTPS set the httpsPort attribute to -1.
    Note: You must explicitly set the port to -1 rather than delete the httpsPort attribute as deleting the attribute causes the httpsPort value that is found in HCL Quality Server installation directory\usr\server\defaultServer\server.generated.xml to be used instead.
  5. HCL Quality Server in some scenarios returns the URL that it can be accessed at. If you change the HTTP Endpoint that the server can be accessed at, then this URL must be updated:
    1. Open the file container.server.properties. The file is typically found in HCL Quality Server installation directory\usr\servers\defaultServer\apps\RTCP.war\WEB-INF\classes on Windows computers or HCL Quality Server installation directory/usr/servers/defaultServer/apps/RTCP.war/WEB-INF/classes on non-Windows computers.
    2. Update the rtcp.base.url property so that the URL has the correct scheme and associated port. For example, https\://defaultServer\:5443/RTCP.
      Note: If both HTTP and HTTPS are enabled, then you must choose one and update it.
  6. Change the HTTP/TCP proxy (registration.xml) to set the server base URL so that the scheme and port match the appropriate port that is defined in the httpEndpoint element above. For details about the server base URL, see Modifying the configuration settings of the HTTP/TCP proxy.
  7. Change the HCL OneTest™ API Agent (Agent.config) to set the server base URL so that the scheme and port match the appropriate port defined in the httpEndpoint element above. For details about the server base URL, see Registering HCL OneTest API Agent with HCL Quality Server.
  8. Restart the services (server, HCL OneTest API Agent, HTTP/TCP proxy). Follow each of the referenced topics for details about restarting each service.
  9. You must also configure the other intercept technologies, such as the Java Virtualization or SIBus tooling that communicate with HCL Quality Server to use the expected scheme.
  10. Any HCL OneTest API projects that previously connected with the server must be updated to communicate with the server to use HTTP or HTTPS. Set the server connection settings to match the scheme and port number from your HTTP or HTTPS server configuration. For information about how to change the server connections settings, see Project settings.
Feedback