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

Create a DAO for the CleverPush Segments 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 MySegmentsDAO {
  //request specific data from CleverPush (String type is used for simplicity)
  @SqlQuery("SELECT Name FROM Segments WHERE ChannelId = :channelId")
  String findNameByChannelId(@Bind("channelId") String channelId);

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

Open a Connection to CleverPush

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

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

Cleverpush API Profile Settings

CleverPush uses private API keys to authenticate requests. Your API key is passed as the Authorization request header value on every API call.

You can find your private API key in the CleverPush dashboard under Settings > API. Use the private key (not the public key) for server-side access.

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your CleverPush private API key.

Optional Connection Properties

• ChannelId: Set this to your default CleverPush channel identifier. Most tables require a channel filter. Setting this property allows queries without specifying ChannelId in every WHERE clause.

Built-in Connection String Designer

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

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

//do stuff with the DAO

dao.close();

Read CleverPush Data

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

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

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