Create a Data Access Object for HCL Domino Data using JDBI

Ready to get started?

Download a free trial of the HCL Domino Driver to get started:

 Download Now

Learn more:

HCL Domino Icon HCL Domino JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with HCL Domino.

A brief overview of creating a SQL Object API for HCL Domino 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 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 walks through building 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.


The connector requires the Proton component to be installed. Normally, Proton is distributed as part of the AppDev pack. See the HCL documentation for instructions on acquiring and installing Proton or the AppDev pack.

Once the Proton service is installed and running, you will also need to create a user account and download its Internet certificate. This certificate can be used to set the connector certificate connection properties.

Authenticating to Domino

  • Server: The name or IP address of the server running Domino with the Proton service.
  • Port: The port number that the Proton service is listening on.
  • Database: The name of the database file, including the .nsf extension.
  • SSLClientCertType: This must match the format of the certificate file. Typically this will be either PEMKEY_FILE for .pem certificates or PFXFILE for .pfx certificates.
  • SSLClientCert: The path to the certificate file.
  • SSLServerCert: This can be set to (*) if you trust the server. This is usually the case, but if you want to perform SSL validation, you may provide a certificate or thumbprint instead. See the documentation for SSLServerCert for details.

Additional Server Configuration

The connector supports querying Domino views if any are defined. Before views can be queried by the connector they must be registered with the design catalog.

Please refer to the Catalog Administration section of the AppDev pack documentation for details on how to do this.

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.

A connection string for HCL Domino 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:domino:Server=;Database=names.nsf;Port=3002;SSLClientCertType=PEMKEY_FILE;SSLClientCert=full_path_of_certificate.pem;SSLServerCert=*"); MyByNameDAO dao =; //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.