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

Create a DAO for the Omnisend Batches 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 MyBatchesDAO {
  //request specific data from Omnisend (String type is used for simplicity)
  @SqlQuery("SELECT Method FROM Batches WHERE Status = :status")
  String findMethodByStatus(@Bind("status") String status);

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

Open a Connection to Omnisend

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

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

Omnisend API Profile Settings

Navigate to your Omnisend account integrations at https://app.omnisend.com/#/my-account/integrations/api-keys to generate an API key.

Built-in Connection String Designer

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

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

//do stuff with the DAO

dao.close();

Read Omnisend Data

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

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

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