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

Create a DAO for the Onfleet Administrators 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 MyAdministratorsDAO {
  //request specific data from Onfleet (String type is used for simplicity)
  @SqlQuery("SELECT  FROM Administrators WHERE  = :")
  String findBy(@Bind("") String );

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

Open a Connection to Onfleet

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

Onfleet uses HTTP ApiKey Authentication. Your Onfleet API Key is used to authenticate requests. You can generate or view your API Key in the Onfleet dashboard under Settings > API.

Using ApiKey Authentication

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Onfleet API Key.

Example connection string:

Profile=C:\profiles\Onfleet.apip;AuthScheme=APIKey;ProfileSettings="ApiKey=your_api_key";

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Onfleet.apip;AuthScheme=APIKey;ProfileSettings="ApiKey=your_api_key";

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\Onfleet.apip;AuthScheme=APIKey;ProfileSettings="ApiKey=your_api_key";");
MyAdministratorsDAO dao = dbi.open(MyAdministratorsDAO.class);

//do stuff with the DAO

dao.close();

Read Onfleet Data

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

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

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