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

Create a DAO for the Retently Campaigns 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 MyCampaignsDAO {
  //request specific data from Retently (String type is used for simplicity)
  @SqlQuery("SELECT Value FROM Campaigns WHERE Id = :id")
  String findValueById(@Bind("id") String id);

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

Open a Connection to Retently

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

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

Retently API Profile Settings

Log into your Retently account and navigate to the OAuth settings page to register an application and receive a 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 Retently 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 Retently will typically look like the following:

jdbc:api:Profile=C:\profiles\Retently.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\Retently.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;");
MyCampaignsDAO dao = dbi.open(MyCampaignsDAO.class);

//do stuff with the DAO

dao.close();

Read Retently Data

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

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

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