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

Create a DAO for the Jumpseller Apps 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 MyAppsDAO {
  //request specific data from Jumpseller (String type is used for simplicity)
  @SqlQuery("SELECT Name FROM Apps WHERE Author = :author")
  String findNameByAuthor(@Bind("author") String author);

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

Open a Connection to Jumpseller

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

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

Jumpseller API Profile Settings

In your Jumpseller store admin panel, navigate to Apps > Developers > Add Application to register an OAuth app and obtain a 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 Jumpseller 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 Jumpseller will typically look like the following:

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

//do stuff with the DAO

dao.close();

Read Jumpseller Data

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

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

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