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

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

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

Open a Connection to Superchat

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

Superchat uses API Key authentication. The API key is passed via the X-API-KEY request header on every call.

Authentication

To authenticate to Superchat, you need to obtain your API key from the Superchat workspace settings.

Using API Key Authentication

You can obtain your API key from Settings > Integrations > API Key in your Superchat workspace.

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

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Superchat API key.

Example connection string:

Profile=C:\profiles\Superchat.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';

Built-in Connection String Designer

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

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

//do stuff with the DAO

dao.close();

Read Superchat Data

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

//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 Superchat by integrating with the CData JDBC Driver for Superchat. Download a free trial and work with live Superchat data in custom Java applications today.