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

Create a DAO for the Moosend Campaign 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 MyCampaignDAO {
  //request specific data from Moosend (String type is used for simplicity)
  @SqlQuery("SELECT Name FROM Campaign 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 Moosend

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

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

Moosend API Profile Settings

Obtain your API key from the Settings page in your Moosend account dashboard.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Moosend.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\Moosend.apip;ProfileSettings='APIKey=your_api_key';");
MyCampaignDAO dao = dbi.open(MyCampaignDAO.class);

//do stuff with the DAO

dao.close();

Read Moosend Data

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

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

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