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

Create a DAO for the Freshteam Branches 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 MyBranchesDAO {
  //request specific data from Freshteam (String type is used for simplicity)
  @SqlQuery("SELECT Name FROM Branches WHERE MainOffice = :mainOffice")
  String findNameByMainOffice(@Bind("mainOffice") String mainOffice);

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

Open a Connection to Freshteam

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

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

Freshteam API Profile Settings

Find your API Key in the top-right corner of your Freshteam account under the API Key section. Your AccountName is the subdomain of your Freshteam URL.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Freshteam.apip;ProfileSettings='APIKey=your_api_key;AccountName=your_account_name';

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\Freshteam.apip;ProfileSettings='APIKey=your_api_key;AccountName=your_account_name';");
MyBranchesDAO dao = dbi.open(MyBranchesDAO.class);

//do stuff with the DAO

dao.close();

Read Freshteam Data

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

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

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