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

Create a DAO for the BugHerd Tasks 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 MyTasksDAO {
  //request specific data from BugHerd (String type is used for simplicity)
  @SqlQuery("SELECT Title FROM Tasks WHERE ProjectId = :projectId")
  String findTitleByProjectId(@Bind("projectId") String projectId);

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

Open a Connection to BugHerd

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

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

BugHerd API Profile Settings

BugHerd uses HTTP Basic authentication with an API key as the username. To obtain an API key:

1. Sign in to your BugHerd account at https://www.bugherd.com
2. Navigate to Settings > General Settings
3. Locate the API Key section and copy the generated key

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

• AuthScheme: Set this to APIKey.

Set the following in the ProfileSettings connection property:

• APIKey: Set this to your BugHerd API key. The driver uses the key as the Basic auth username and sets the password internally to the literal value 'x' as required by BugHerd.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\BugHerd.apip;AuthScheme=APIKey;ProfileSettings='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\BugHerd.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';");
MyTasksDAO dao = dbi.open(MyTasksDAO.class);

//do stuff with the DAO

dao.close();

Read BugHerd Data

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

//disply the result of our 'find' method
String title = dao.findTitleByProjectId("519666");
System.out.println(title);

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