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

Create a DAO for the Paymo ClientContacts 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 MyClientContactsDAO {
  //request specific data from Paymo (String type is used for simplicity)
  @SqlQuery("SELECT Name FROM ClientContacts WHERE ClientId = :clientId")
  String findNameByClientId(@Bind("clientId") String clientId);

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

Open a Connection to Paymo

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

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

Paymo API Profile Settings

Log into your Paymo account, navigate to My Settings > Integrations > API Keys, and select Generate New Key to create your API key.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Paymo.apip;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\Paymo.apip;ProfileSettings='APIKey=your_api_key';");
MyClientContactsDAO dao = dbi.open(MyClientContactsDAO.class);

//do stuff with the DAO

dao.close();

Read Paymo Data

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

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

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