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

Create a DAO for the Recurly AccountAcquisition 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 MyAccountAcquisitionDAO {
  //request specific data from Recurly (String type is used for simplicity)
  @SqlQuery("SELECT Object FROM AccountAcquisition WHERE Channel = :channel")
  String findObjectByChannel(@Bind("channel") String channel);

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

Open a Connection to Recurly

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

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

Recurly API Profile Settings

Navigate to Integrations > API Credentials in your Recurly account and click Add Private API Key.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Recurly.apip;ProfileSettings='APIKey=your_api_key';

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

//do stuff with the DAO

dao.close();

Read Recurly Data

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

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

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