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

Create a DAO for the Mouseflow FeedbackCampaigns 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 MyFeedbackCampaignsDAO {
  //request specific data from Mouseflow (String type is used for simplicity)
  @SqlQuery("SELECT CampaignId FROM FeedbackCampaigns WHERE Enabled = :enabled")
  String findCampaignIdByEnabled(@Bind("enabled") String enabled);

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

Open a Connection to Mouseflow

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

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

Mouseflow API Profile Settings

Retrieve your API key from API > API Key within your Mouseflow account settings. Your region (us or eu) can be determined from your account URL.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Mouseflow.apip;ProfileSettings='User=your_email;Password=your_api_key;Region=us';

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\Mouseflow.apip;ProfileSettings='User=your_email;Password=your_api_key;Region=us';");
MyFeedbackCampaignsDAO dao = dbi.open(MyFeedbackCampaignsDAO.class);

//do stuff with the DAO

dao.close();

Read Mouseflow Data

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

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

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