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

Create a DAO for the SendInBlue Account 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 MyAccountDAO {
  //request specific data from SendInBlue (String type is used for simplicity)
  @SqlQuery("SELECT FirstName FROM Account WHERE Plan = :plan")
  String findFirstNameByPlan(@Bind("plan") String plan);

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

Open a Connection to SendInBlue

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

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

SendInBlue API Profile Settings

In your SendInBlue account, click your username in the top right, select SMTP & API, and copy your API key from that page.

Built-in Connection String Designer

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

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

//do stuff with the DAO

dao.close();

Read SendInBlue Data

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

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

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