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

Create a DAO for the Tickspot Clients 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 MyClientsDAO {
  //request specific data from Tickspot (String type is used for simplicity)
  @SqlQuery("SELECT Name FROM Clients WHERE Archive = :archive")
  String findNameByArchive(@Bind("archive") String archive);

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

Open a Connection to Tickspot

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

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

Tickspot API Profile Settings

Obtain your API Token and Subscription ID by querying the Roles table using your Tickspot login email and password. Use the returned APIKey and SubscriptionId for all subsequent requests.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Tickspot.apip;ProfileSettings='APIKey=your_api_key;SubscriptionId=your_subscription_id';

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\Tickspot.apip;ProfileSettings='APIKey=your_api_key;SubscriptionId=your_subscription_id';");
MyClientsDAO dao = dbi.open(MyClientsDAO.class);

//do stuff with the DAO

dao.close();

Read Tickspot Data

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

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

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