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

Create a DAO for the ActiveTrail GroupMembers 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 MyGroupMembersDAO {
  //request specific data from ActiveTrail (String type is used for simplicity)
  @SqlQuery("SELECT Email FROM GroupMembers WHERE GroupId = :groupId")
  String findEmailByGroupId(@Bind("groupId") String groupId);

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

Open a Connection to ActiveTrail

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

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

ActiveTrail API Profile Settings

ActiveTrail uses API key authentication. To obtain an API key:

1. Log in to your ActiveTrail account at https://app.activetrail.com
2. Navigate to your account settings and locate the API integration section
3. Generate or copy your existing API key

After obtaining your API key, set the following connection properties:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your ActiveTrail API key.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\ActiveTrail.apip;AuthScheme=APIKey;APIKey=your_api_key;

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\ActiveTrail.apip;AuthScheme=APIKey;APIKey=your_api_key;");
MyGroupMembersDAO dao = dbi.open(MyGroupMembersDAO.class);

//do stuff with the DAO

dao.close();

Read ActiveTrail Data

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

//disply the result of our 'find' method
String email = dao.findEmailByGroupId("356069");
System.out.println(email);

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