Learn more
 

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.

In this article

Related articles

Connect to HCL Domino Data in JRuby


Create a simple JRuby app with access to live HCL Domino data.

JRuby is a high-performance, stable, fully threaded Java implementation of the Ruby programming language. The CData JDBC Driver for HCL Domino makes it easy to integrate connectivity to live HCL Domino data in JRuby. This article shows how to create a simple JRuby app that connects to HCL Domino data, executes a query, and displays the results.

Configure a JDBC Connection to HCL Domino Data

Before creating the app, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for HCL Domino\lib).

JRuby natively supports JDBC, so you can easily connect to HCL Domino and execute SQL queries. Initialize the JDBC connection with the getConnection function of the java.sql.DriverManager class.

Prerequisites

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.

Below is a typical JDBC connection string for HCL Domino:

jdbc:domino:Server=https://domino.corp.com;Database=names.nsf;Port=3002;SSLClientCertType=PEMKEY_FILE;SSLClientCert=full_path_of_certificate.pem;SSLServerCert=*

Create a JRuby App with Connectivity to HCL Domino Data

Create a new Ruby file (for example: DominoSelect.rb) and open it in a text editor. Copy the following code into your file:

require 'java' require 'rubygems' require 'C:/Program Files/CData/CData JDBC Driver for HCL Domino 2018/lib/cdata.jdbc.domino.jar' url = "jdbc:domino:Server=https://domino.corp.com;Database=names.nsf;Port=3002;SSLClientCertType=PEMKEY_FILE;SSLClientCert=full_path_of_certificate.pem;SSLServerCert=*" conn = java.sql.DriverManager.getConnection(url) stmt = conn.createStatement rs = stmt.executeQuery("SELECT Name, Address FROM ByName") while (rs.next) do puts rs.getString(1) + ' ' + rs.getString(2) end

With the file completed, you are ready to display your HCL Domino data with JRuby. To do so, simply run your file from the command line:

jruby -S DominoSelect.rb

Writing SQL-92 queries to HCL Domino allows you to quickly and easily incorporate HCL Domino data into your own JRuby applications. Download a free trial today!