Modifying the configuration settings of the JDBC proxy

You can modify the registration.xml file of the JDBC proxy to change the server address, log level, and other settings.

Procedure

  1. The JDBCIntercept.zip package provided with HCL Quality Server contains the registration.xml file. This file contains the configuration settings for the JDBC proxy. Download and extract the file that is provided with HCL Quality Server. For more information, see HCL OneTest™ API tool packages.
  2. Use a text editor to open the registration.xml file.
  3. Edit the configuration settings as shown in the following table:
    Table 1. JDBC proxy configuration settings
    Configurable setting Description
    <server base-url="https://<Host name or IP address selected during installation of the server>:5443/RTCP" security-token="" />

    By default, a HCL Quality Server installation listens for proxy registration on port 5443.

    If your HCL Quality Server installation uses a different port number, enter the number in this field.

    Set the security-token value if you want to use domain-level security for the proxy. For more information about security-tokens, see Configuring agents and proxies to use security tokens.

    ssl The SSL connection details that you want to use to connect to the server. The SSL element is optional. If the ssl element is not included, then the proxy uses the Java keystore location and password that is found in the system properties javax.net.ssl.trustStore and javax.net.ssl.trustStorePassword. If these properties are not set, then the proxy trusts all server certificates.
    trustAll
    If set to true, this attribute tells the proxy to trust all certificates that are presented by the server. In this case, the trustStore, trustStoreType and trustStorePassword attributes are ignored.
    trustStore
    The path to the keystore that contains the trusted certificates that are used to verify the certificate that is presented by the server. By default this attribute's value is set to the path of the greenhatTrusted.jks keystore, which is included with the HTTP/TCP proxy and contains the HCL OneTest™ API Root CA certificate. If the server's certificate was changed, then this value must also be changed to point to a keystore that contains a certificate that can be used to verify the new server certificate. For more information about configuring the server certificate, see Using your own truststore for server SSL connections.
    trustStoreType
    The type attribute specifies the type of the keystore. If not specified, the default value is jks.
    trustStorePassword
    The password attribute specifies the password that is used to load the keystore file. The password for the default truststore is passphrase.
    protocol
    The protocol attribute defines the SSL handshake protocol used to connect to the server.

    Default value: SSL_TLSv2, TLS.

    The specified default options are checked for availability. SSL_TLSv2 protocol is supported by the JRE and, if it is unavailable, the TLS protocol is used.

    logger level
    Options are as follows:
    • debug
    • error
    • info
    • warning
    Choose and of these levels.

    identifier name

    This setting is for specifying a name for this proxy. A name makes it easier to identify a specific proxy when several proxies of the same type are registered with HCL Quality Server.
    Note: By default, this setting is commented out. Therefore, to use this setting, you must first uncomment it and then specify the identifier name.
    domains

    Generally, there is no need to edit the domain and environment tags.

    However, if you use HCL Quality Server to set up specific business domains and environments, do the following tasks:
    • Set the name attribute of the domain tag to the domain name in the HCL OneTest™ API project that is used to record SQL events.
    • Set the name attribute of the environment tag to the name of the environment that is selected in the project for recording SQL events.
    Note: If the domain and environment tags are not modified, the driver is available for recording and stubbing in all projects that reference the HCL Quality Server installation with which the driver is registered.

    statistics initial-state

    Setting the initial state to on will set the observation level for this intercept in HCL Quality Server to Statistics when the intercept first registers with HCL Quality Server.

    Setting the initial state to off will set the observation level for this intercept to None when the intercept first registers.

    includes and excludes section

    By default, the JDBC driver is set to intercept all of the JDBC connections that the application makes.

    To enable or disable the driver for specific connections, use the include and exclude options.

    You can either specify the complete URL of the connection or control several similar connections with a prefix.

    While processing intercepts, the details in the include section is considered before applying the exclude section details.
    Warning: An empty <includes> section disables the driver.
    Here is an example to include a single connection and exclude all of the other connections:
    <includes>
    	<include>jdbc:oracle:thin:@devhost:9080:database2</include>
    </includes>
    Here is an example to exclude all the DB2® and local Oracle connections but include all the other connections:
    <excludes>
    	<exclude>jdbc:db2</exclude>
    	<exclude>jdbc:oracle:thin:@localhost</exclude>
    </excludes>
    reporting frequency By default, observations are reported by the proxy every 10 seconds. If you increase the reporting interval, fewer observation messages are sent over the network, but the data is not available to HCL OneTest™ API as frequently. The value is specified in seconds, and values between 5 and 30 are allowed.
  4. Save and close the file.

What to do next

If you make any changes to the registration.xml file after deploying the JDBC proxy, restart each stand-alone application and hosted application that is communicating with the JDBC proxy; otherwise, the changes will not take effect.
Note: You might also need to make configuration changes to each stand-alone application and hosted application that is communicating with the JDBC proxy. For more information about this task, see the related links.
Feedback