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

Create a DAO for the Missive Conversations 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 MyConversationsDAO {
  //request specific data from Missive (String type is used for simplicity)
  @SqlQuery("SELECT Subject FROM Conversations WHERE Status = :status")
  String findSubjectByStatus(@Bind("status") String status);

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

Open a Connection to Missive

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

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

Missive API Profile Settings

Generate an API token in your Missive account under Settings > API Tokens.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Missive.apip;ProfileSettings='Token=your_bearer_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\Missive.apip;ProfileSettings='Token=your_bearer_token';");
MyConversationsDAO dao = dbi.open(MyConversationsDAO.class);

//do stuff with the DAO

dao.close();

Read Missive Data

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

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

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