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

Create a DAO for the Office 365 Files 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 MyFilesDAO {
 //insert new data into Office 365
 @SqlUpdate("INSERT INTO Files (UserId, Size) values (:userId, :size)")
 void insert(@Bind("userId") String userId, @Bind("size") String size);

 //request specific data from Office 365 (String type is used for simplicity)
 @SqlQuery("SELECT Size FROM Files WHERE UserId = :userId")
 String findSizeByUserId(@Bind("userId") String userId);

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

Open a Connection to Office 365

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

Office 365 uses the OAuth authentication standard. To authenticate requests, obtain the OAuthClientId, OAuthClientSecret, and OAuthCallbackURL by registering an app with Office 365. See the "Getting Started" chapter of the help documentation for a guide to using OAuth.

Built-in Connection String Designer

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

java -jar cdata.jdbc.office365.jar

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

A connection string for Office 365 will typically look like the following:

jdbc:office365:OAuthClientId=MyApplicationId;OAuthClientSecret=MyAppKey;OAuthCallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH;

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:office365:OAuthClientId=MyApplicationId;OAuthClientSecret=MyAppKey;OAuthCallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH;");
MyFilesDAO dao = dbi.open(MyFilesDAO.class);

//do stuff with the DAO

dao.close();

Read Office 365 Data

With the connection open to Office 365, simply call the previously defined method to retrieve data from the Files entity in Office 365.

//disply the result of our 'find' method
String size = dao.findSizeByUserId("54f34750-0d34-47c9-9949-9fac4791cddb");
System.out.println(size);

Write Office 365 Data

It is also simple to write data to Office 365, using the previously defined method.

//add a new entry to the Files entity
dao.insert(newUserId, newSize);

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