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

Create a DAO for the Mode DataSources 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 MyDataSourcesDAO {
  //request specific data from Mode (String type is used for simplicity)
  @SqlQuery("SELECT Token FROM DataSources WHERE Public = :public")
  String findTokenByPublic(@Bind("public") String public);

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

Open a Connection to Mode

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

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

Mode API Profile Settings

In Mode, go to My Account > API Tokens to generate an access token and access secret, which serve as the User and Password credentials respectively.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Mode.apip;ProfileSettings='User=your_api_access_token;Password=your_access_secret';

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\Mode.apip;ProfileSettings='User=your_api_access_token;Password=your_access_secret';");
MyDataSourcesDAO dao = dbi.open(MyDataSourcesDAO.class);

//do stuff with the DAO

dao.close();

Read Mode Data

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

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

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