Object-Relational Mapping (ORM) with HCL Domino Data Entities in Java

You can use Hibernate to map object-oriented domain models to a traditional relational database. The tutorial below shows how to use the CData JDBC Driver for HCL Domino to generate an ORM of your HCL Domino repository with Hibernate.

Though Eclipse is the IDE of choice for this article, the CData JDBC Driver for HCL Domino works in any product that supports the Java Runtime Environment. In the Knowledge Base you will find tutorials to connect to HCL Domino data from IntelliJ IDEA and NetBeans.

Install Hibernate

Follow the steps below to install the Hibernate plug-in in Eclipse.

1. In Eclipse, navigate to Help -> Install New Software.
2. Enter "http://download.jboss.org/jbosstools/neon/stable/updates/" in the Work With box.
3. Enter "Hibernate" into the filter box.
4. Select Hibernate Tools.

Start A New Project

Follow the steps below to add the driver JARs in a new project.

1. Create a new project. Select Java Project as your project type and click Next. Enter a project name and click Finish.
2. Right-click the project and click Properties. Click Java Build Path and then open the Libraries tab.
3. Click Add External JARs to add the cdata.jdbc.domino.jar library, located in the lib subfolder of the installation directory.

Add a Hibernate Configuration File

Follow the steps below to configure connection properties to HCL Domino data.

1. Right-click on the new project and select New -> Hibernate -> Hibernate Configuration File (cfg.xml).
2. Select src as the parent folder and click Next.

3. Input the following values:

   • Hibernate version:: 5.2
   • Database dialect: Derby
   • Driver class: cdata.jdbc.domino.DominoDriver

   • Connection URL: A JDBC URL, starting with jdbc:domino: and followed by a semicolon-separated list of connection properties.

     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 Azure Active Directory 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.

     AzureAD

     This authentication method uses Azure Active Directory as an IdP to obtain a JWT token. You need to create a custom OAuth application in Azure Active Directory 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 "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 Azure Active Directory > 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.

     A typical JDBC URL is below:

     jdbc:domino:Server=https://domino.corp.com;AuthScheme=OAuthPassword;User=my_domino_user;Password=my_domino_password;

Connect Hibernate to HCL Domino Data

Follow the steps below to select the configuration you created in the previous step.

1. Switch to the Hibernate Configurations perspective: Window -> Open Perspective -> Hibernate.
2. Right-click on the Hibernate Configurations panel and click Add Configuration.
3. Set the Hibernate version to 5.2.
4. Click the Browse button and select the project.
5. For the Configuration file field, click Setup -> Use Existing and select the location of the hibernate.cfg.xml file (inside src folder in this demo).
6. In the Classpath tab, if there is nothing under User Entries, click Add External JARS and add the driver jar once more. Click OK once the configuration is done.
7. Expand the Database node of the newly created Hibernate configurations file.

Reverse Engineer HCL Domino Data

Follow the steps below to generate the reveng.xml configuration file. You will specify the tables you want to access as objects.

1. Switch back to the Package Explorer.
2. Right-click your project, select New -> Hibernate -> Hibernate Reverse Engineering File (reveng.xml). Click Next.
3. Select src as the parent folder and click Next.
4. In the Console configuration drop-down menu, select the Hibernate configuration file you created above and click Refresh.
5. Expand the node and choose the tables you want to reverse engineer. Click Finish when you are done.

Configure Hibernate to Run

Follow the steps below to generate plain old Java objects (POJO) for the HCL Domino tables.

1. From the menu bar, click Run -> Hibernate Code Generation -> Hibernate Code Generation Configurations.
2. In the Console configuration drop-down menu, select the Hibernate configuration file you created in the previous section. Click Browse by Output directory and select src.
3. Enable the Reverse Engineer from JDBC Connection checkbox. Click the Setup button, click Use Existing, and select the location of the hibernate.reveng.xml file (inside src folder in this demo).
4. In the Exporters tab, check Domain code (.java) and Hibernate XML Mappings (hbm.xml).
5. Click Run.

One or more POJOs are created based on the reverse-engineering setting in the previous step.

Insert Mapping Tags

For each mapping you have generated, you will need to create a mapping tag in hibernate.cfg.xml to point Hibernate to your mapping resource. Open hibernate.cfg.xml and insert the mapping tags as so:

Execute SQL

Using the entity you created from the last step, you can now search HCL Domino data: import java.util.*; import org.hibernate.Session; import org.hibernate.cfg.Configuration; import org.hibernate.query.Query; public class App { public static void main(final String[] args) { Session session = new Configuration().configure().buildSessionFactory().openSession(); String SELECT = "FROM ByName B WHERE City = :City"; Query q = session.createQuery(SELECT, ByName.class); q.setParameter("City","Miami"); List<ByName> resultList = (List<ByName>) q.list(); for(ByName s: resultList){ System.out.println(s.getName()); System.out.println(s.getAddress()); } } }