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

Create a DAO for the AdRoll 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 AdRoll (String type is used for simplicity)
  @SqlQuery("SELECT Name FROM Accounts WHERE IsSuspended = :isSuspended")
  String findNameByIsSuspended(@Bind("isSuspended") String isSuspended);

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

Open a Connection to AdRoll

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

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

AdRoll API Profile Settings

Register a developer account with AdRoll and create an OAuth application to receive a client ID and secret.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\AdRoll.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\AdRoll.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 AdRoll Data

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

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

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