Create a Data Access Object for Microsoft Planner Data using JDBI

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Microsoft Planner JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Microsoft Planner.

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

Create a DAO for the Microsoft Planner Tasks 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 MyTasksDAO { //insert new data into Microsoft Planner @SqlUpdate("INSERT INTO Tasks (TaskId, startDateTime) values (:taskId, :startDateTime)") void insert(@Bind("taskId") String taskId, @Bind("startDateTime") String startDateTime); //request specific data from Microsoft Planner (String type is used for simplicity) @SqlQuery("SELECT startDateTime FROM Tasks WHERE TaskId = :taskId") String findstartDateTimeByTaskId(@Bind("taskId") String taskId); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to Microsoft Planner

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

You can connect without setting any connection properties for your user credentials. Below are the minimum connection properties required to connect.

  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
  • Tenant (optional): Set this if you wish to authenticate to a different tenant than your default. This is required to work with an organization not on your default Tenant.

When you connect the Driver opens the MS Planner OAuth endpoint in your default browser. Log in and grant permissions to the Driver. The Driver then completes the OAuth process.

  1. Extracts the access token from the callback URL and authenticates requests.
  2. Obtains a new access token when the old one expires.
  3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

Built-in Connection String Designer

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

java -jar cdata.jdbc.microsoftplanner.jar

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

A connection string for Microsoft Planner 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:microsoftplanner:OAuthClientId=MyApplicationId;OAuthClientSecret=MySecretKey;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH"); MyTasksDAO dao =; //do stuff with the DAO dao.close();

Read Microsoft Planner Data

With the connection open to Microsoft Planner, simply call the previously defined method to retrieve data from the Tasks entity in Microsoft Planner.

//disply the result of our 'find' method String startDateTime = dao.findstartDateTimeByTaskId("BCrvyMoiLEafem-3RxIESmUAHbLK"); System.out.println(startDateTime);

Write Microsoft Planner Data

It is also simple to write data to Microsoft Planner, using the previously defined method.

//add a new entry to the Tasks entity dao.insert(newTaskId, newstartDateTime);

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