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

Create a DAO for the SurveyMonkey MySurvey_Responses 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 MyMySurvey_ResponsesDAO {
 //request specific data from SurveyMonkey (String type is used for simplicity)
 @SqlQuery("SELECT ChoiceId FROM MySurvey_Responses WHERE ChoiceText = :choiceText")
 String findChoiceIdByChoiceText(@Bind("choiceText") String choiceText);

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

Open a Connection to SurveyMonkey

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

SurveyMonkey uses the OAuth 2 authentication standard. See the Getting Started section in the help documentation for a guide.

Built-in Connection String Designer

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

java -jar cdata.jdbc.surveymonkey.jar

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

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

jdbc:surveymonkey:OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:portNumber;InitiateOAuth=GETANDREFRESH;

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:surveymonkey:OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:portNumber;InitiateOAuth=GETANDREFRESH;");
MyMySurvey_ResponsesDAO dao = dbi.open(MyMySurvey_ResponsesDAO.class);

//do stuff with the DAO

dao.close();

Read SurveyMonkey Data

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

//disply the result of our 'find' method
String choiceId = dao.findChoiceIdByChoiceText("blue");
System.out.println(choiceId);

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