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

Create a DAO for the Bannerbear Account 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 MyAccountDAO {
  //request specific data from Bannerbear (String type is used for simplicity)
  @SqlQuery("SELECT CreatedAt FROM Account WHERE PaidPlanName = :paidPlanName")
  String findCreatedAtByPaidPlanName(@Bind("paidPlanName") String paidPlanName);

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

Open a Connection to Bannerbear

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

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

Bannerbear API Profile Settings

Retrieve your API keys from the Bannerbear dashboard. Specify the key type (Project or Master) via the KeyType property.

Built-in Connection String Designer

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

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

//do stuff with the DAO

dao.close();

Read Bannerbear Data

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

//disply the result of our 'find' method
String createdAt = dao.findCreatedAtByPaidPlanName("premium");
System.out.println(createdAt);

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