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

Create a DAO for the Timely Accounts 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 MyAccountsDAO {
  //request specific data from Timely (String type is used for simplicity)
  @SqlQuery("SELECT Name FROM Accounts 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 Timely

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

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

Timely API Profile Settings

Register an OAuth application through your Timely account under Settings > Devs > New 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 Timely 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 Timely will typically look like the following:

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

//do stuff with the DAO

dao.close();

Read Timely Data

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

//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 Timely by integrating with the CData JDBC Driver for Timely. Download a free trial and work with live Timely data in custom Java applications today.