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

Create a DAO for the Teamgate Activities 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 MyActivitiesDAO {
  //request specific data from Teamgate (String type is used for simplicity)
  @SqlQuery("SELECT Status FROM Activities WHERE Status = :status")
  String findStatusByStatus(@Bind("status") String status);

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

Open a Connection to Teamgate

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

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

Teamgate API Profile Settings

To obtain your API Key, log into Teamgate and navigate to Settings > Additional Features > External Apps > New API Key Request. For your Auth Token, go to My Profile > Integrations > API Access > Auth Token.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Teamgate.apip;ProfileSettings='APIKey=your_api_key;AuthToken=your_auth_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\Teamgate.apip;ProfileSettings='APIKey=your_api_key;AuthToken=your_auth_token';");
MyActivitiesDAO dao = dbi.open(MyActivitiesDAO.class);

//do stuff with the DAO

dao.close();

Read Teamgate Data

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

//disply the result of our 'find' method
String status = dao.findStatusByStatus("Completed");
System.out.println(status);

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