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

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

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

Open a Connection to Pingdom

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

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

Pingdom API Profile Settings

In your Pingdom account, navigate to Integrations > The Pingdom API and create a new API Token to use as your API key.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Pingdom.apip;ProfileSettings='APIKey=your_api_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\Pingdom.apip;ProfileSettings='APIKey=your_api_token';");
MyActionsDAO dao = dbi.open(MyActionsDAO.class);

//do stuff with the DAO

dao.close();

Read Pingdom Data

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

//disply the result of our 'find' method
String username = dao.findUsernameByStatus("delivered");
System.out.println(username);

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