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

Create a DAO for the HelloSign 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 HelloSign (String type is used for simplicity)
  @SqlQuery("SELECT EmailAddress FROM Account WHERE IsPaidHs = :isPaidHs")
  String findEmailAddressByIsPaidHs(@Bind("isPaidHs") String isPaidHs);

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

Open a Connection to HelloSign

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

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

HelloSign API Profile Settings

Navigate to Settings > API > API Key in your HelloSign (Dropbox Sign) account to obtain your API key.

Built-in Connection String Designer

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

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

//do stuff with the DAO

dao.close();

Read HelloSign Data

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

//disply the result of our 'find' method
String emailAddress = dao.findEmailAddressByIsPaidHs("true");
System.out.println(emailAddress);

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