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

Create a DAO for the Demio Event 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 MyEventDAO {
  //request specific data from Demio (String type is used for simplicity)
  @SqlQuery("SELECT Name FROM Event WHERE Automated = :automated")
  String findNameByAutomated(@Bind("automated") String automated);

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

Open a Connection to Demio

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

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

Demio API Profile Settings

Navigate to Account Settings > API in your Demio account (Owner access required) to obtain your API Key and API Secret.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Demio.apip;ProfileSettings='APIKey=your_api_key;APISecret=your_api_secret';

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\Demio.apip;ProfileSettings='APIKey=your_api_key;APISecret=your_api_secret';");
MyEventDAO dao = dbi.open(MyEventDAO.class);

//do stuff with the DAO

dao.close();

Read Demio Data

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

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

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