Ready to get started?

Download a free trial of the Oracle Service Cloud Driver to get started:

 Download Now

Learn more:

Oracle Service Cloud Icon Oracle Service Cloud JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Oracle Service Cloud.

Create a Data Access Object for Oracle Service Cloud Data using JDBI

A brief overview of creating a SQL Object API for Oracle Service Cloud data in 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 Service Cloud integrates connectivity to live Oracle Service Cloud data in Java applications. By pairing these technologies, you gain simple, programmatic access to Oracle Service Cloud data. This article walks through building a basic Data Access Object (DAO) and the accompanying code to read and write Oracle Service Cloud data.

Create a DAO for the Oracle Service Cloud Accounts 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 MyAccountsDAO { //insert new data into Oracle Service Cloud @SqlUpdate("INSERT INTO Accounts (DisplayOrder, LookupName) values (:displayOrder, :lookupName)") void insert(@Bind("displayOrder") String displayOrder, @Bind("lookupName") String lookupName); //request specific data from Oracle Service Cloud (String type is used for simplicity) @SqlQuery("SELECT LookupName FROM Accounts WHERE DisplayOrder = :displayOrder") String findLookupNameByDisplayOrder(@Bind("displayOrder") String displayOrder); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to Oracle Service Cloud

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

Using Basic Authentication

You must set the following to authenticate to Oracle Service Cloud:

  • Url: The Url of the account to connect to.
  • User: The username of the authenticating account.
  • Password: The password of the authenticating account.

Built-in Connection String Designer

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

java -jar cdata.jdbc.oracleservicecloud.jar

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

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


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:oracleservicecloud:Url=;User=user;Password=password;"); MyAccountsDAO dao =; //do stuff with the DAO dao.close();

Read Oracle Service Cloud Data

With the connection open to Oracle Service Cloud, simply call the previously defined method to retrieve data from the Accounts entity in Oracle Service Cloud.

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

Write Oracle Service Cloud Data

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

//add a new entry to the Accounts entity dao.insert(newDisplayOrder, newLookupName);

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