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

Create a DAO for the Oracle SCM Carriers 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 MyCarriersDAO {
 //request specific data from Oracle SCM (String type is used for simplicity)
 @SqlQuery("SELECT CarrierName FROM Carriers WHERE ActiveFlag = :activeFlag")
 String findCarrierNameByActiveFlag(@Bind("activeFlag") String activeFlag);

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

Open a Connection to Oracle SCM

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

The following connection properties are required to connect to Oracle SCM data.

• Url: The URL of the account that you want to connect to. Typically, this will be the URL of your Oracle Cloud service. For example, https://servername.fa.us2.oraclecloud.com.
• User: The username of your Oracle Cloud service account.
• Password: The password of your Oracle Cloud service account.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Oracle SCM JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.oraclescm.jar

Fill in the connection properties and copy the connection string to the clipboard.

A connection string for Oracle SCM will typically look like the following:

jdbc:oraclescm:Url=https://myinstance.oraclecloud.com;User=user;Password=password;

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:oraclescm:Url=https://myinstance.oraclecloud.com;User=user;Password=password;");
MyCarriersDAO dao = dbi.open(MyCarriersDAO.class);

//do stuff with the DAO

dao.close();

Read Oracle SCM Data

With the connection open to Oracle SCM, simply call the previously defined method to retrieve data from the Carriers entity in Oracle SCM.

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

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