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

Create a DAO for the Typeform Tags 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 MyTagsDAO {
 //request specific data from Typeform (String type is used for simplicity)
 @SqlQuery("SELECT Title FROM Tags WHERE SettingsIsPublic = :settingsIsPublic")
 String findTitleBySettingsIsPublic(@Bind("settingsIsPublic") String settingsIsPublic);

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

Open a Connection to Typeform

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

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

TypeForm API Profile Settings

Authentication to TypeForm uses the OAuth standard.

To authenticate to TypeForm, you must first register and configure an OAuth application with TypeForm here: https://admin.typeform.com/account#/section/tokens. Your app will be assigned a client ID and a client secret which can be set in the connection string. More information on setting up an OAuth application can be found at https://developer.typeform.com/get-started/.

Note that there are several different use scenarios which all require different redirect URIs:

• CData Desktop Applications: CData desktop applications (Sync, API Server, ArcESB) accept OAuth tokens at /src/oauthCallback.rst. The host and port is the same as the default port used by the application. For example, if you use http://localhost:8019/ to access CData Sync then the redirect URI will be http://localhost:8019/src/oauthCallback.rst.
• CData Cloud Applications: CData cloud applications are similar to their desktop counterparts. If you access Connect AI at https://1.2.3.4/ then you should use the redirect https://1.2.3.4/src/oauthCallback.rst.
• Desktop Application: When using a desktop application, the URI https://localhost:33333 is recommended.
• Web Application: When developing a web application using the driver, use your own URI here such as https://my-website.com/oauth.

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to OAuth.
• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
• OAuthClientId: Set this to the Client Id that is specified in your app settings.
• OAuthClientSecret: Set this to Client Secret that is specified in your app settings.
• CallbackURL: Set this to the Redirect URI you specified in your app settings.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\TypeForm.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

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\TypeForm.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;");
MyTagsDAO dao = dbi.open(MyTagsDAO.class);

//do stuff with the DAO

dao.close();

Read Typeform Data

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

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

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