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

Create a DAO for the Optimizely Attributes 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 MyAttributesDAO {
  //request specific data from Optimizely (String type is used for simplicity)
  @SqlQuery("SELECT Name FROM Attributes WHERE ProjectId = :projectId")
  String findNameByProjectId(@Bind("projectId") String projectId);

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

Open a Connection to Optimizely

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

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

Optimizely API Profile Settings

Generate a personal API token at app.optimizely.com/v2/profile/api in your Optimizely account settings.

Built-in Connection String Designer

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

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

//do stuff with the DAO

dao.close();

Read Optimizely Data

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

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

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