How to connect JDBC-ODBC Bridge to Java

Introduction

You can connect to your JDBC data source data using Java using the high-performance JDBC-ODBC Bridge Driver. We'll walk you through the entire setup.

Let's not waste time and get started!

Prerequisites

Before we begin, make sure you meet the following prerequisite: Java Runtime Environment (JRE) or Java Development Kit (JDK) must be installed on your system.

• Minimum required version: Java 8
  • Amazon Corretto 8
  • Oracle JRE 8
• Recommended Java version: Java 21
  • Amazon Corretto 21
  • Oracle JRE 21

If your JDBC Driver targets a different Java version (e.g., 11 / 17 / 21), install the corresponding or newer Java version.

Download your Java application JDBC driver

To connect to your Java application, you will have to download JDBC driver for it, which we will use in later steps. Let's perform these little steps right away:

1. Visit your Java application website or MVN Repository.

2. Select the appropriate JDBC driver version in Latest Versions section in MVN Repository:

   

3. Download the JDBC driver, and save it locally, e.g. to D:\Drivers\JDBC\app-jdbc.jar.

   

4. Done! That was easy, wasn't it? Let's proceed to the next step.

Create data source in ZappySys Data Gateway

In this section we will create a data source for JDBC-ODBC Bridge in the Data Gateway. Let's follow these steps to accomplish that:

1. Download and install ODBC PowerPack (if you haven't already).

2. Search for gateway in the Windows Start Menu and open ZappySys Data Gateway Configuration:

   

3. Go to the Users tab and follow these steps to add a Data Gateway user:

   • Click the Add button
   • In the Login field enter a username, e.g., john
   • Then enter a Password
   • Check the Is Administrator checkbox
   • Click OK to save
   

4. Now we are ready to add a data source:

   • Click the Add button
   • Give the Data source a name (have it handy for later)
   • Then select Native - ZappySys JDBC Bridge Driver
   • Finally, click OK
   JdbcOdbcBridgeDSN

   ZappySys JDBC Bridge Driver

   

5. Now, we need to configure the JDBC connection in the new ODBC data source. Simply enter the Connection string, credentials, configure other settings, and then click Test Connection button to test the connection:

   JdbcOdbcBridgeDSN

   jdbc:exampleApp://app-service-host-name.com:1234

   com.provider.exampleApp.jdbc.AppDriver

   D:\Drivers\JDBC\app-jdbc.jar

   admin

   *************

   [{"Name":"AppParameter","Value":"12345"}]

   

   Use these values when setting parameters:

   • Connection string: jdbc:exampleApp://app-service-host-name.com:1234
   • Driver class: com.provider.exampleApp.jdbc.AppDriver
   • JDBC driver file(s): D:\Drivers\JDBC\app-jdbc.jar
   • User name: admin
   • User password: *************
   • Connection parameters: [{"Name":"AppParameter","Value":"12345"}]

6. You should see a message saying that connection test is successful:

   

7. Otherwise, if you are getting an error, start by troubleshooting the JDBC connection with DBeaver in the section below:

   Jump to troubleshooter

8. We are at the point where we can preview a SQL query. For more SQL query examples visit JDBC Bridge documentation:

   JdbcOdbcBridgeDSN

   SELECT * FROM orders

   

   SELECT * FROM orders

   You can also click on the <Select Table> dropdown and select a table from the list.

   The ZappySys JDBC Bridge Driver acts as a transparent intermediary, passing SQL queries directly to the JDBC driver, which then handles the query execution. This means the JDBC-ODBC Bridge Driver simply relays the SQL query without altering it.

   Some JDBC drivers don't support INSERT/UPDATE/DELETE statements, so you may get an error saying "action is not supported" or a similar one. Please, be aware, this is not the limitation of ZappySys JDBC Bridge Driver, but is a limitation of the specific JDBC driver you are using.

9. Click OK to finish creating the data source.

10. Once done, go to the Network Settings tab and Add a firewall rule for inbound traffic:

    
    • This will initially allow all inbound traffic.
    • Click Edit IP filters to restrict access to specific IP addresses or ranges.

11. Crucial Step: After creating or modifying the data source, you must:

    • Click the Save button to persist your changes.
    • Hit Yes when prompted to restart the Data Gateway service.

    This ensures all changes are properly applied:

    
    Skipping this step may cause the new settings to fail, preventing you from connecting to the data source.

Read data in Java from the DSN

1. Java code to get the data:
   

   "jdbc:sqlserver://localhost:5000;databasename=JdbcOdbcBridgeDSN;user=john;password=test"

   

2. When you run the code it will make the API call and read the data:
   

3. Here is Java program's code in text format:

   
   //Step-1: Install ZappySys ODBC PowerPack and Configure Data Gateway
   
   //Step-2:Assuming the Microsoft SQL Server JDBC Driver is in below folder
   //C:\Program Files\Microsoft Jdbc Driver 6.0 for SQL Server\sqljdbc_6.0\enu\auth\x64
   package padaone;
   
   import java.sql.*;
   
   public class zappy {
   
       public static void main(String[] args) {
   
           // Create a variable for the connection string.
           String connectionUrl = "jdbc:sqlserver://localhost:5000;databasename=JdbcOdbcBridgeDSN;user=test;password=test";
   
           // Declare the JDBC objects.
           Connection con = null;
           Statement stmt = null;
           ResultSet rs = null;
   
               try {
                   // Establish the connection.
                   Class.forName("com.microsoft.sqlserver.jdbc.SQLServerDriver");
                   con = DriverManager.getConnection(connectionUrl);
   
                   // Create and execute an SQL statement that returns some data.
                   String SQL = "SELECT Country , SUM(UnitPrice * Quantity) Total " 
                              + "FROM value " 
                              + "GROUP BY Country "
                              + "WITH (SRC='https://services.odata.org/V3/Northwind/Northwind.svc/Invoices?$format=json')";
                   stmt = con.createStatement();
                   rs = stmt.executeQuery(SQL);
   
                   // Iterate through the data in the result set and display it.
                   while (rs.next()) {
                       System.out.println(rs.getString(1) + " " + rs.getString(2));
                   }
               }
   
           // Handle any errors that may have occurred.
           catch (Exception e) {
               e.printStackTrace();
           } 
           
           finally {
               if (rs != null) try { rs.close(); } catch (Exception e) {}
               if (stmt != null) try { stmt.close(); } catch (Exception e) {}
               if (con != null) try { con.close(); } catch (Exception e) {}
           }
       }
   }

Troubleshooting

Validating JDBC connection in DBeaver

If you are experiencing JDBC connection issues, start by testing your JDBC driver in a JDBC client tool like DBeaver. If the JDBC connection fails in DBeaver, it naturally will not work in your ODBC data source either.

Create generic JDBC driver

1. Download and install DBeaver Community Edition.

2. Open DBeaver.

3. Click Database in the top menu and select Driver Manager:

   

4. Click the New button to start adding a custom JDBC driver:

   

5. Configure the connection settings by entering the Driver Name and Class Name (com.provider.exampleApp.jdbc.AppDriver):

   

   com.provider.exampleApp.jdbc.AppDriver

6. Go to the Libraries tab, click Add File, and select your JDBC-ODBC Bridge driver library file(s), e.g. D:\Drivers\JDBC\app-jdbc.jar:

   
   Make sure to add all the required library dependencies.

7. Your JDBC driver jar library is now added:

   

   D:\Drivers\JDBC\app-jdbc.jar

8. (Optional). If required by your JDBC driver, add additional properties by going to the Default properties tab, Right-clicking on the background, and selecting Add new property:

   

9. Click on a value to modify it, then click OK to finish:

   

We are now ready to test the connection. Let's proceed!

Test connection

1. Click the New Database Connection icon in the toolbar:

   

2. Select your newly created JDBC driver from the list and click Next:

   

3. Enter your JDBC URL (e.g. jdbc:exampleApp://app-service-host-name.com:1234), click Test Connection to verify it works, and then click Finish:

   

   jdbc:exampleApp://app-service-host-name.com:1234

4. Finally, expand the database and table list to check the connection status:

   

There are two possible outcomes from the connection test:

• Reason:
  The JDBC driver works perfectly, meaning the issue lies within your ODBC data source configuration.
• Action:
  Double-check your ODBC data source configuration and ensure it matches the settings that successfully connected in DBeaver.

• Reason:
  There is likely an issue with the JDBC driver configuration or the connection details provided.
• Action:
  Contact the ZappySys Support Team for assistance.

If you are still experiencing issues or need further help, please contact us:

Frequent issues and solutions

Below are some useful community articles to help you troubleshoot and configure the ZappySys JDBC Bridge Driver:

• How to combine multiple JAR files
  Learn how to merge multiple .jar dependencies when your JDBC driver requires more than one file.
• How to fix JBR error: “Data lake is not available / Unable to verify trust for server certificate chain”
  Resolve SSL or certificate validation issues encountered during JDBC connections.
• System Exception: “Java is not installed or not accessible”
  Fix Java path or environment issues that prevent the JDBC Bridge from launching Java.
• JDBC Bridge Driver disconnect from Java host error
  Troubleshoot unexpected disconnection problems between your client application and the Java process.
• Error: Could not open jvm.cfg while using JDBC Bridge Driver
  Resolve JVM configuration path errors during driver initialization.
• How to enable JDBC Bridge Driver logging
  Enable detailed driver logging for better visibility during troubleshooting.
• How to pass JDBC connection parameters (not by URL)
  Learn how to specify connection properties programmatically instead of embedding them in the JDBC URL.
• How to fix JDBC Bridge error: “No connection could be made because the target machine actively refused it”
  Troubleshoot firewall or local port binding issues preventing communication with the Java host.
• How to use JDBC Bridge options (System Property for Java command line, e.g., classpath, proxy)
  Configure custom Java options like classpath and proxy using JDBC Bridge system properties.