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

Create a DAO for the Testmonitor Applications 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 MyApplicationsDAO {
  //request specific data from Testmonitor (String type is used for simplicity)
  @SqlQuery("SELECT Name FROM Applications WHERE Name = :name")
  String findNameByName(@Bind("name") String name);

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

Open a Connection to Testmonitor

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

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

Testmonitor API Profile Settings

Generate a token in TestMonitor by navigating to My Account > API > Create Token. Your Domain is extracted from your account subdomain.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Testmonitor.apip;ProfileSettings='APIKey=your_api_key;Domain=your_subdomain';

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\Testmonitor.apip;ProfileSettings='APIKey=your_api_key;Domain=your_subdomain';");
MyApplicationsDAO dao = dbi.open(MyApplicationsDAO.class);

//do stuff with the DAO

dao.close();

Read Testmonitor Data

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

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

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