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

Create a DAO for the HCL Domino ByName 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 MyByNameDAO {
 //request specific data from HCL Domino (String type is used for simplicity)
 @SqlQuery("SELECT Address FROM ByName WHERE City = :city")
 String findAddressByCity(@Bind("city") String city);

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

Open a Connection to HCL Domino

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to HCL Domino.

Connecting to Domino

To connect to Domino data, set the following properties:

• URL: The host name or IP of the server hosting the Domino database. Include the port of the server hosting the Domino database. For example: http://sampleserver:1234/
• DatabaseScope: The name of a scope in the Domino Web UI. The driver exposes forms and views for the schema governed by the specified scope. In the Domino Admin UI, select the Scopes menu in the sidebar. Set this property to the name of an existing scope.

Authenticating with Domino

Domino supports authenticating via login credentials or an Entra ID (formerly Azure AD) OAuth application:

Login Credentials

To authenticate with login credentials, set the following properties:

• AuthScheme: Set this to "OAuthPassword"
• User: The username of the authenticating Domino user
• Password: The password associated with the authenticating Domino user

The driver uses the login credentials to automatically perform an OAuth token exchange.

EntraID (formerly AzureAD)

This authentication method uses Entra ID (formerly Azure AD) as an IdP to obtain a JWT token. You need to create a custom OAuth application in Entra ID (formerly Azure AD) and configure it as an IdP. To do so, follow the instructions in the Help documentation. Then set the following properties:

• AuthScheme: Set this to "EntraID (formerly AzureAD)"
• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
• OAuthClientId: The Client ID obtained when setting up the custom OAuth application.
• OAuthClientSecret: The Client secret obtained when setting up the custom OAuth application.
• CallbackURL: The redirect URI defined when you registered your app. For example: https://localhost:33333
• AzureTenant: The Microsoft Online tenant being used to access data. Supply either a value in the form companyname.microsoft.com or the tenant ID.

  The tenant ID is the same as the directory ID shown in the Azure Portal's Entra ID (formerly Azure AD) > Properties page.

Built-in Connection String Designer

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

java -jar cdata.jdbc.domino.jar

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

👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

A connection string for HCL Domino will typically look like the following:

jdbc:domino:Server=https://domino.corp.com;AuthScheme=OAuthPassword;User=my_domino_user;Password=my_domino_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:domino:Server=https://domino.corp.com;AuthScheme=OAuthPassword;User=my_domino_user;Password=my_domino_password;");
MyByNameDAO dao = dbi.open(MyByNameDAO.class);

//do stuff with the DAO

dao.close();

Read HCL Domino Data

With the connection open to HCL Domino, simply call the previously defined method to retrieve data from the ByName entity in HCL Domino.

//disply the result of our 'find' method
String address = dao.findAddressByCity("Miami");
System.out.println(address);

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