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

Create a DAO for the DocuSign Documents 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 MyDocumentsDAO {
 //request specific data from DocuSign (String type is used for simplicity)
 @SqlQuery("SELECT DocumentName FROM Documents WHERE DocumentName = :documentName")
 String findDocumentNameByDocumentName(@Bind("documentName") String documentName);

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

Open a Connection to DocuSign

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

To connect to DocuSign, set the following connection properties:

• UseSandbox: indicates whether current user account is sandbox or not (FALSE by default)
• AccountId (optional): set it in the connection string if you have access to multiple Account Ids

Authenticating to DocuSign

DocuSign uses the OAuth authentication standard. To authenticate using OAuth, create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties. See the Help documentation more information.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the DocuSign JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.docusign.jar

Fill in the connection properties and copy the connection string to the clipboard.

A connection string for DocuSign will typically look like the following:

jdbc:docusign:OAuthClientId=MyClientId; OAuthClientSecret=MyClientSecret; CallbackURL=http://localhost:33333;

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:docusign:OAuthClientId=MyClientId; OAuthClientSecret=MyClientSecret; 
CallbackURL=http://localhost:33333;
");
MyDocumentsDAO dao = dbi.open(MyDocumentsDAO.class);

//do stuff with the DAO

dao.close();

Read DocuSign Data

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

//disply the result of our 'find' method
String documentName = dao.findDocumentNameByDocumentName("TPSReport");
System.out.println(documentName);

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