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

Create a DAO for the PivotalTracker AccountMemberships 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 MyAccountMembershipsDAO {
  //request specific data from PivotalTracker (String type is used for simplicity)
  @SqlQuery("SELECT Id FROM AccountMemberships WHERE Admin = :admin")
  String findIdByAdmin(@Bind("admin") String admin);

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

Open a Connection to PivotalTracker

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

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

PivotalTracker API Profile Settings

Navigate to your Pivotal Tracker Profile settings and locate the API token section to copy your unique API token.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\PivotalTracker.apip;ProfileSettings='APIKey=your_api_token';

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\PivotalTracker.apip;ProfileSettings='APIKey=your_api_token';");
MyAccountMembershipsDAO dao = dbi.open(MyAccountMembershipsDAO.class);

//do stuff with the DAO

dao.close();

Read PivotalTracker Data

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

//disply the result of our 'find' method
String id = dao.findIdByAdmin("true");
System.out.println(id);

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