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

Create a DAO for the Planio Companies 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 MyCompaniesDAO {
  //request specific data from Planio (String type is used for simplicity)
  @SqlQuery("SELECT Name FROM Companies WHERE Country = :country")
  String findNameByCountry(@Bind("country") String country);

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

Open a Connection to Planio

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

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

Planio API Profile Settings

Enable the REST API in Planio Administration Settings, then go to My Account > API Access Key and click Show to reveal your API key. Your subdomain is the prefix of your Planio account URL.

Built-in Connection String Designer

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

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

//do stuff with the DAO

dao.close();

Read Planio Data

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

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

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