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

Create a DAO for the CampaignMonitor AccountAdministrators 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 MyAccountAdministratorsDAO {
  //request specific data from CampaignMonitor (String type is used for simplicity)
  @SqlQuery("SELECT Name FROM AccountAdministrators WHERE Status = :status")
  String findNameByStatus(@Bind("status") String status);

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

Open a Connection to CampaignMonitor

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

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

CampaignMonitor API Profile Settings

Log into Campaign Monitor, go to Account Settings > API Keys, and click to generate or view your API key.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Campaignmonitor.apip;ProfileSettings='APIKey=your_api_key';

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

//do stuff with the DAO

dao.close();

Read CampaignMonitor Data

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

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

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