Create a Data Access Object for ZohoSubscriptions 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 ZohoSubscriptions integrates connectivity to live ZohoSubscriptions data in Java applications. By pairing these technologies, you gain simple, programmatic access to ZohoSubscriptions data. This article explains how to build a basic Data Access Object (DAO) and the accompanying code to read ZohoSubscriptions data.

Create a DAO for the ZohoSubscriptions Addons 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 MyAddonsDAO {
  //request specific data from ZohoSubscriptions (String type is used for simplicity)
  @SqlQuery("SELECT AddonCode FROM Addons WHERE Status = :status")
  String findAddonCodeByStatus(@Bind("status") String status);

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

Open a Connection to ZohoSubscriptions

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

Start by setting the Profile connection property to the location of the ZohoSubscriptions Profile on disk (e.g. C:\profiles\ZohoSubscriptions.apip). Next, set the ProfileSettings connection property to the connection string for ZohoSubscriptions (see below).

ZohoSubscriptions API Profile Settings

Register an OAuth application in the Zoho Developer Console as a server-based application to obtain your Client ID and Client Secret.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the ZohoSubscriptions 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 ZohoSubscriptions will typically look like the following:

jdbc:api:Profile=C:\profiles\ZohoSubscriptions.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

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\ZohoSubscriptions.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;");
MyAddonsDAO dao = dbi.open(MyAddonsDAO.class);

//do stuff with the DAO

dao.close();

Read ZohoSubscriptions Data

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

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

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