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

Create a DAO for the Teamwork Account 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 MyAccountDAO {
  //request specific data from Teamwork (String type is used for simplicity)
  @SqlQuery("SELECT Name FROM Account WHERE ChatEnabled = :chatEnabled")
  String findNameByChatEnabled(@Bind("chatEnabled") String chatEnabled);

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

Open a Connection to Teamwork

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

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

Teamwork API Profile Settings

Register an OAuth application on the Teamwork Developer Portal to obtain your Client ID and Secret. Set the Domain property to your Teamwork site's subdomain.

Built-in Connection String Designer

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

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

//do stuff with the DAO

dao.close();

Read Teamwork Data

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

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

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