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

Create a DAO for the Hubstaff AttendanceSchedules 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 MyAttendanceSchedulesDAO {
  //request specific data from Hubstaff (String type is used for simplicity)
  @SqlQuery("SELECT Id FROM AttendanceSchedules WHERE StartDate = :startDate")
  String findIdByStartDate(@Bind("startDate") String startDate);

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

Open a Connection to Hubstaff

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

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

Hubstaff API Profile Settings

Register an OAuth application at developer.hubstaff.com/apps 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 Hubstaff 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 Hubstaff will typically look like the following:

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

//do stuff with the DAO

dao.close();

Read Hubstaff Data

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

//disply the result of our 'find' method
String id = dao.findIdByStartDate("2025-01-15");
System.out.println(id);

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