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

Create a DAO for the Qualaroo SurveyResponses 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 MySurveyResponsesDAO {
  //request specific data from Qualaroo (String type is used for simplicity)
  @SqlQuery("SELECT  FROM SurveyResponses WHERE SurveyId = :surveyId")
  String findBySurveyId(@Bind("surveyId") String surveyId);

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

Open a Connection to Qualaroo

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

Qualaroo uses HTTP Basic Authentication to control access to the API. You will need your API Key and API Secret, which can be found under Account Details > Reporting API in the Qualaroo dashboard.

Using Basic Authentication

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to Basic.
• User: Set this to your Qualaroo API Key.
• Password: Set this to your Qualaroo API Secret.

Example connection string:

Profile=C:\profiles\Qualaroo.apip;AuthScheme=Basic;User=your_api_key;Password=your_api_secret;

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Qualaroo.apip;AuthScheme=Basic;User=your_api_key;Password=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\Qualaroo.apip;AuthScheme=Basic;User=your_api_key;Password=your_api_secret;");
MySurveyResponsesDAO dao = dbi.open(MySurveyResponsesDAO.class);

//do stuff with the DAO

dao.close();

Read Qualaroo Data

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

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

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