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

Create a DAO for the Oracle Sales Opportunities 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 MyOpportunitiesDAO {
 //insert new data into Oracle Sales
 @SqlUpdate("INSERT INTO Opportunities (CreatedBy, Name) values (:createdBy, :name)")
 void insert(@Bind("createdBy") String createdBy, @Bind("name") String name);

 //request specific data from Oracle Sales (String type is used for simplicity)
 @SqlQuery("SELECT Name FROM Opportunities WHERE CreatedBy = :createdBy")
 String findNameByCreatedBy(@Bind("createdBy") String createdBy);

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

Open a Connection to Oracle Sales

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

Oracle Sales uses Basic authentication over SSL; after setting the following connection properties, you are ready to connect:

• Username: Set this to the user name that you use to log into your Oracle Cloud service.
• Password: Set this to your password.
• HostURL: Set this to the Web address (URL) of your Oracle Cloud service.

Built-in Connection String Designer

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

java -jar cdata.jdbc.oraclesalescloud.jar

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

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

jdbc:oraclesalescloud:HostURL=https://my.host.oraclecloud.com; Username=abc123; Password=abcdef;

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:oraclesalescloud:HostURL=https://my.host.oraclecloud.com; Username=abc123; Password=abcdef;");
MyOpportunitiesDAO dao = dbi.open(MyOpportunitiesDAO.class);

//do stuff with the DAO

dao.close();

Read Oracle Sales Data

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

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

Write Oracle Sales Data

It is also simple to write data to Oracle Sales, using the previously defined method.

//add a new entry to the Opportunities entity
dao.insert(newCreatedBy, newName);

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