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

Create a DAO for the LightSpeedRetail Account 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 MyAccountDAO {
  //request specific data from LightSpeedRetail (String type is used for simplicity)
  @SqlQuery("SELECT Name FROM Account WHERE Name = :name")
  String findNameByName(@Bind("name") String name);

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

Open a Connection to LightSpeedRetail

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

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

LightSpeedRetail API Profile Settings

Register an OAuth application at the LightSpeed Retail OAuth Client registration page to obtain your Client ID and Client Secret.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\LightSpeedRetail.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\LightSpeedRetail.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;");
MyAccountDAO dao = dbi.open(MyAccountDAO.class);

//do stuff with the DAO

dao.close();

Read LightSpeedRetail Data

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

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

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