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
-
Open
HCL Quality Server installation directory\config\server.custom.xml
in a text editor. -
Uncomment the example
httpEndpoint
element.<httpEndpoint id="defaultHttpEndpoint" httpPort="7819" httpsPort="5443" />
Note: If this element is missing, it can be copied fromHCL Quality Server installation directory\usr\servers\defaultServer\server.generated.xml
. -
For plain HTTP communication set the
httpPort
attribute to a valid port, for example 7819. To disable plain HTTP set thehttpPort
attribute to -1.Note: You must explicitly set the port to -1 rather than delete thehttpPort
attribute as deleting the attribute causes thehttpPort
value found inHCL Quality Server installation directory\usr\server\defaultServer\server.generated.xml
to be used instead. -
For HTTPS communication set the
httpsPort
attribute to a valid port, for example 5443. To disable HTTPS set thehttpsPort
attribute to -1.Note: You must explicitly set the port to -1 rather than delete thehttpsPort
attribute as deleting the attribute causes thehttpsPort
value that is found inHCL Quality Server installation directory\usr\server\defaultServer\server.generated.xml
to be used instead. -
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:
- Open the file
container.server.properties
. The file is typically found inHCL Quality Server installation directory\usr\servers\defaultServer\apps\RTCP.war\WEB-INF\classes
on Windows computers orHCL Quality Server installation directory/usr/servers/defaultServer/apps/RTCP.war/WEB-INF/classes
on non-Windows computers. - 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.
- Open the file
-
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 thehttpEndpoint
element above. For details about the server base URL, see Modifying the configuration settings of the HTTP/TCP proxy. -
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 thehttpEndpoint
element above. For details about the server base URL, see Registering HCL OneTest API Agent with HCL Quality Server. - Restart the services (server, HCL OneTest™ API Agent, HTTP/TCP proxy). Follow each of the referenced topics for details about restarting each service.
- 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.
- 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.