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

Create a DAO for the Close Activities 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 MyActivitiesDAO {
  //request specific data from Close (String type is used for simplicity)
  @SqlQuery("SELECT ContactId FROM Activities WHERE Type = :type")
  String findContactIdByType(@Bind("type") String type);

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

Open a Connection to Close

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

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

Close API Profile Settings

Locate your API key through Close's Settings menu under Your API Keys and create a new key if needed.

Built-in Connection String Designer

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

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

//do stuff with the DAO

dao.close();

Read Close Data

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

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

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