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

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

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

Open a Connection to JobNimbus

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

Using API Key Authentication

JobNimbus uses API key authentication to control access to the API. To obtain a JobNimbus API key:

1. Log in to your JobNimbus account.
2. Navigate to Settings > Integrations > API.
3. Generate or copy your existing API key from this page.

After obtaining your API key, set the following connection properties:

• AuthScheme: Set this to APIKey.

• APIKey: Set this to your JobNimbus API key.

Example Connection String

Profile=C:\profiles\JobNimbus.apip;AuthScheme=APIKey;ProfileSettings='APIKey=my_api_key';

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\JobNimbus.apip;AuthScheme=APIKey;ProfileSettings='APIKey=my_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\JobNimbus.apip;AuthScheme=APIKey;ProfileSettings='APIKey=my_api_key';");
MyAccountUsersDAO dao = dbi.open(MyAccountUsersDAO.class);

//do stuff with the DAO

dao.close();

Read JobNimbus Data

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

//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 JobNimbus by integrating with the CData JDBC Driver for JobNimbus. Download a free trial and work with live JobNimbus data in custom Java applications today.