Create a Data Access Object for Gong Data using JDBI

JDBI is a SQL convenience library for Java that exposes two different style APIs, a fluent style and a SQL object style. The CData JDBC Driver for Gong integrates connectivity to live Gong data in Java applications. By pairing these technologies, you gain simple, programmatic access to Gong data. This article explains how to build a basic Data Access Object (DAO) and the accompanying code to read Gong data.

Create a DAO for the Gong AnsweredScorecards Entity

The interface below declares the desired behavior for the SQL object to create a single method for each SQL statement to be implemented.

public interface MyAnsweredScorecardsDAO {
  //request specific data from Gong (String type is used for simplicity)
  @SqlQuery("SELECT  FROM AnsweredScorecards WHERE  = :")
  String findBy(@Bind("") String );

  /*
   * close with no args is used to close the connection
   */
  void close();
}

Open a Connection to Gong

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to Gong.

To authenticate to Gong, you can use API Key authentication with your Gong API Key and API Secret.

Authentication

To authenticate to Gong, you must provide your Gong API Key and API Secret, along with your tenant Domain. These credentials are combined and Base64-encoded to form the Basic authentication header used for all API requests.

Using API Key Authentication

To authenticate using an API Key, you need to obtain your API Key and API Secret from your Gong account settings.

You can then connect by setting the AuthScheme to APIKey and providing your credentials:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Gong API Key.
• APISecret: Set this to your Gong API Secret.
• Domain: Set this to your Gong tenant domain (e.g., us-36533.api.gong.io).

Example connection string

Profile=C:\profiles\Gong.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key;APISecret=your_api_secret;Domain=your-tenant.api.gong.io';

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Gong JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.api.jar

Fill in the connection properties and copy the connection string to the clipboard.

A connection string for Gong will typically look like the following:

jdbc:api:Profile=C:\profiles\Gong.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key;APISecret=your_api_secret;Domain=your-tenant.api.gong.io';

Use the configured JDBC URL to obtain an instance of the DAO interface. The particular method shown below will open a handle bound to the instance, so the instance needs to be closed explicitly to release the handle and the bound JDBC connection.

DBI dbi = new DBI("jdbc:api:Profile=C:\profiles\Gong.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key;APISecret=your_api_secret;Domain=your-tenant.api.gong.io';");
MyAnsweredScorecardsDAO dao = dbi.open(MyAnsweredScorecardsDAO.class);

//do stuff with the DAO

dao.close();

Read Gong Data

With the connection open to Gong, simply call the previously defined method to retrieve data from the AnsweredScorecards entity in Gong.

//disply the result of our 'find' method
String  = dao.findBy("");
System.out.println();

Since the JDBI library is able to work with JDBC connections, you can easily produce a SQL Object API for Gong by integrating with the CData JDBC Driver for Gong. Download a free trial and work with live Gong data in custom Java applications today.