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

Create a DAO for the Avaza Account 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 MyAccountDAO {
  //request specific data from Avaza (String type is used for simplicity)
  @SqlQuery("SELECT CompanyName FROM Account WHERE DefaultCurrencyCode = :defaultCurrencyCode")
  String findCompanyNameByDefaultCurrencyCode(@Bind("defaultCurrencyCode") String defaultCurrencyCode);

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

Open a Connection to Avaza

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

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

Avaza API Profile Settings

Register an OAuth application in Avaza under Settings > Manage Developer Apps > OAuth 2 Apps > Add OAuth App to obtain your client ID and secret credentials.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Avaza.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

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\Avaza.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;");
MyAccountDAO dao = dbi.open(MyAccountDAO.class);

//do stuff with the DAO

dao.close();

Read Avaza Data

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

//disply the result of our 'find' method
String companyName = dao.findCompanyNameByDefaultCurrencyCode("USD");
System.out.println(companyName);

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