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

Create a DAO for the ChargeOver AdminWorkers 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 MyAdminWorkersDAO {
  //request specific data from ChargeOver (String type is used for simplicity)
  @SqlQuery("SELECT Email FROM AdminWorkers WHERE Username = :username")
  String findEmailByUsername(@Bind("username") String username);

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

Open a Connection to ChargeOver

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

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

ChargeOver API Profile Settings

Log into ChargeOver, navigate to Settings > Developer > REST API, enable the API, and copy your Public Key (APIKey) and Private Key (APISecret).

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Chargeover.apip;ProfileSettings='APIKey=your_public_key;APISecret=your_private_key;Domain=your_subdomain';

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\Chargeover.apip;ProfileSettings='APIKey=your_public_key;APISecret=your_private_key;Domain=your_subdomain';");
MyAdminWorkersDAO dao = dbi.open(MyAdminWorkersDAO.class);

//do stuff with the DAO

dao.close();

Read ChargeOver Data

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

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

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