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

Create a DAO for the AgileCRM Campaigns 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 MyCampaignsDAO {
  //request specific data from AgileCRM (String type is used for simplicity)
  @SqlQuery("SELECT Name FROM Campaigns WHERE IsDisabled = :isDisabled")
  String findNameByIsDisabled(@Bind("isDisabled") String isDisabled);

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

Open a Connection to AgileCRM

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

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

AgileCRM API Profile Settings

Log in to AgileCRM and go to Admin Settings > Developers & API > REST API to find your API key. Your domain is the subdomain from your AgileCRM account URL.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Agilecrm.apip;ProfileSettings='APIKey=your_api_key;Domain=your_domain;User=your_email';

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\Agilecrm.apip;ProfileSettings='APIKey=your_api_key;Domain=your_domain;User=your_email';");
MyCampaignsDAO dao = dbi.open(MyCampaignsDAO.class);

//do stuff with the DAO

dao.close();

Read AgileCRM Data

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

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

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