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

Create a DAO for the Bugsnag Collaborators 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 MyCollaboratorsDAO {
  //request specific data from Bugsnag (String type is used for simplicity)
  @SqlQuery("SELECT OrganizationId FROM Collaborators WHERE IsAdmin = :isAdmin")
  String findOrganizationIdByIsAdmin(@Bind("isAdmin") String isAdmin);

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

Open a Connection to Bugsnag

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

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

Bugsnag API Profile Settings

Generate your Personal Auth Token in BugSnag under My Account settings.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Bugsnag.apip;ProfileSettings='APIKey=your_personal_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\Bugsnag.apip;ProfileSettings='APIKey=your_personal_auth_token';");
MyCollaboratorsDAO dao = dbi.open(MyCollaboratorsDAO.class);

//do stuff with the DAO

dao.close();

Read Bugsnag Data

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

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

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