Deploying JDBC proxy into Apache Tomcat

The JDBC proxy must be deployed on each application server that is running Apache Tomcat. The JDBC proxy enables a server that hosts applications to use JDBC to access a live database that you want to record or virtualize.


  1. Download and extract the JDBC driver that is provided with HCL Quality Server. For more information, see HCL OneTest API tool packages.
  2. Copy the files, jsqlparser15.jar and antlr-3.4.jar, and the JDBC proxy configuration file (registration.xml) from the downloaded package to <Tomcat installation directory>\common\lib or to whichever Tomcat library folder that contains JDBC drivers.
    JDBC / Java™ version File name Description
    JDBC 4, Java 1.6 or later

    jsqlparser15.jar and antlr-3.4.jar

    The JDBC proxy.

    Supporting libraries.

    • Currently, JDBC 4, Java 1.6 or later is supported for the JDBC proxy and its supporting libraries. You must add the three JAR files, jsqlparser15.jar and antlr-3.4.jar to each application server directory that contains JDBC drivers.
    • The following items are not supported for vendor-specific Oracle SQLs:
      • Oracle-specific DDL statements
      • Custom functions
      • Subqueries
      • PIVOT and UNPIVOT statements
      • Nested tables containing multiple columns or single column of user-defined-types
      • Stubs with nested tables
  3. Configure the Tomcat startup script (%CATALINA_HOME%\bin\catalina.bat, if you are using Microsoft Windows; or $CATALINA_HOME/bin/, if you are using Unix-like systems) by using the JAVA_OPTS variable to set the jdbc.drivers property as follows:
    SET JAVA_OPTS=%JAVA_OPTS% -Djdbc.drivers=com.greenhat.jdbc.Driver
    Note: If there is already a –D entry that is specifying drivers, ensure that com.greenhat.jdbc.Driver is listed first and that the other entries appended after are in a colon-separated list.
  4. Save and close the file.
  5. If necessary, edit the server tag in the registration.xml file to the URL of the HCL Quality Server installation that is being used.

    For information about modifying this file, see Modifying the configuration settings of the JDBC proxy.

  6. Optional: Edit the domain and environment tags in the registration.xml file.

    If these tags are modified, the JDBC proxy is used only when you record and stub within the specified domain and environment.

  7. Use HCL OneTest API and HCL Quality Server to control JDBC recording and stubbing.