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

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

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

Open a Connection to Mocean

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

Using API Key Authentication

Mocean uses API key authentication to control access to the API. To obtain an API Key:

1. Log in to your Mocean account at https://dashboard.moceanapi.com
2. Navigate to your account settings or API credentials section
3. Copy your API Key

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

• AuthScheme: Set this to APIKey.

• APIKey: Set this to your Mocean API Key. This is transmitted as a Bearer token in the Authorization header.

Example Connection String

Profile=C:\profiles\Mocean.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';

Connecting to Mocean

Once the authentication is configured, you can connect to Mocean and query data from any of the available tables such as AccountBalance, AccountPricing, MessageStatus, and NumberLookup.

Built-in Connection String Designer

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

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

//do stuff with the DAO

dao.close();

Read Mocean Data

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

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