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

Create a DAO for the Sendwithus CustomerLogs 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 MyCustomerLogsDAO {
  //request specific data from Sendwithus (String type is used for simplicity)
  @SqlQuery("SELECT Created FROM CustomerLogs WHERE Status = :status")
  String findCreatedByStatus(@Bind("status") String status);

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

Open a Connection to Sendwithus

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

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

Sendwithus API Profile Settings

Navigate to API Settings in your Sendwithus account and select Create new API Key to generate your authentication credential.

Built-in Connection String Designer

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

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

//do stuff with the DAO

dao.close();

Read Sendwithus Data

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

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

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