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

Create a DAO for the Simplesat Surveys 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 MySurveysDAO {
  //request specific data from Simplesat (String type is used for simplicity)
  @SqlQuery("SELECT  FROM Surveys WHERE  = :")
  String findBy(@Bind("") String );

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

Open a Connection to Simplesat

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

Using API Key Authentication

Simplesat uses API Key authentication. To obtain your API key, log in to your Simplesat account and navigate to Workspace Settings > API. Copy the API key value for use in the connection string.

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

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Simplesat API key obtained from workspace settings.

Built-in Connection String Designer

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

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

//do stuff with the DAO

dao.close();

Read Simplesat Data

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

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

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