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

Create a DAO for the Chargebee 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 Chargebee (String type is used for simplicity)
  @SqlQuery("SELECT Name FROM Addons WHERE Status = :status")
  String findNameByStatus(@Bind("status") String status);

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

Open a Connection to Chargebee

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

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

Chargebee API Profile Settings

Generate an API Key from your Chargebee account via Settings > Configure Chargebee > API Keys and Webhooks. Your site name is the subdomain from your Chargebee account URL.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Chargebee.apip;ProfileSettings='APIKey=your_api_key;Site=your_site_name';

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\Chargebee.apip;ProfileSettings='APIKey=your_api_key;Site=your_site_name';");
MyAddonsDAO dao = dbi.open(MyAddonsDAO.class);

//do stuff with the DAO

dao.close();

Read Chargebee Data

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

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

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