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

Create a DAO for the Humanity Budget 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 MyBudgetDAO {
  //request specific data from Humanity (String type is used for simplicity)
  @SqlQuery("SELECT Store FROM Budget WHERE Location = :location")
  String findStoreByLocation(@Bind("location") String location);

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

Open a Connection to Humanity

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

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

Humanity API Profile Settings

Create an OAuth application from Settings > API V2 in your Humanity account to obtain an App ID and App Secret.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Humanity.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

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\Humanity.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;");
MyBudgetDAO dao = dbi.open(MyBudgetDAO.class);

//do stuff with the DAO

dao.close();

Read Humanity Data

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

//disply the result of our 'find' method
String store = dao.findStoreByLocation("New York");
System.out.println(store);

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