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

Create a DAO for the MailerSend Activity 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 MyActivityDAO {
  //request specific data from MailerSend (String type is used for simplicity)
  @SqlQuery("SELECT  FROM Activity WHERE DomainId = :domainId")
  String findByDomainId(@Bind("domainId") String domainId);

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

Open a Connection to MailerSend

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

The MailerSend API uses API Key authentication via a Bearer token in the Authorization request header.

Using API Key Authentication

Your MailerSend API token is required to create a connection. To obtain your API token:

1. Log into your MailerSend account at app.mailersend.com.
2. Navigate to Settings > API Tokens in your account dashboard.
3. Click Generate new token, provide a name and select the appropriate permissions.
4. Copy the generated API token.

After obtaining your API token, set the following connection properties:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your MailerSend API token.

Example connection string:

Profile=C:\profiles\Mailersend.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_token';

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Mailersend.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_token';

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\Mailersend.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_token';");
MyActivityDAO dao = dbi.open(MyActivityDAO.class);

//do stuff with the DAO

dao.close();

Read MailerSend Data

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

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

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