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

Create a DAO for the Apollo Accounts 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 MyAccountsDAO {
  //request specific data from Apollo (String type is used for simplicity)
  @SqlQuery("SELECT AccountStageId FROM Accounts WHERE Industry = :industry")
  String findAccountStageIdByIndustry(@Bind("industry") String industry);

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

Open a Connection to Apollo

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

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

Apollo API Profile Settings

Register an application with Apollo.io to obtain OAuth credentials from their developer console.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Apollo.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

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\Apollo.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;");
MyAccountsDAO dao = dbi.open(MyAccountsDAO.class);

//do stuff with the DAO

dao.close();

Read Apollo Data

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

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

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