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

Create a DAO for the CloudConvert Jobs 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 MyJobsDAO {
  //request specific data from CloudConvert (String type is used for simplicity)
  @SqlQuery("SELECT  FROM Jobs WHERE  = :")
  String findBy(@Bind("") String );

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

Open a Connection to CloudConvert

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

CloudConvert uses API key authentication. Your CloudConvert API key is used to authenticate requests as a Bearer token. You can generate or view your keys at https://cloudconvert.com/dashboard/api/v2/keys.

Using API Key Authentication

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your CloudConvert API key.

Example connection string:

Profile=C:\profiles\CloudConvert.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";

Built-in Connection String Designer

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

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

//do stuff with the DAO

dao.close();

Read CloudConvert Data

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

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

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