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

Create a DAO for the GetResponse AccountBilling 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 MyAccountBillingDAO {
 //request specific data from GetResponse (String type is used for simplicity)
 @SqlQuery("SELECT PaymentPlan FROM AccountBilling WHERE PaymentMethod = :paymentMethod")
 String findPaymentPlanByPaymentMethod(@Bind("paymentMethod") String paymentMethod);

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

Open a Connection to GetResponse

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

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

GetResponse API Profile Settings

Retrieve your API key from your GetResponse account under My Account > Use GetResponse API.

Built-in Connection String Designer

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

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

//do stuff with the DAO

dao.close();

Read GetResponse Data

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

//disply the result of our 'find' method
String paymentPlan = dao.findPaymentPlanByPaymentMethod("CreditCard");
System.out.println(paymentPlan);

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