Access Live HCL Domino Data in AWS Lambda

AWS Lambda is a compute service that lets you build applications that respond quickly to new information and events. AWS Lambda functions can work with live HCL Domino data when paired with the CData JDBC Driver for HCL Domino. This article describes how to connect to and query HCL Domino data from an AWS Lambda function built in Eclipse.

At the time this article was written (June 2022), Eclipse version 2019-12 and Java 8 were the highest versions supported by the AWS Toolkit for Eclipse.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live HCL Domino data. When you issue complex SQL queries to HCL Domino, the driver pushes supported SQL operations, like filters and aggregations, directly to HCL Domino and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). In addition, its built-in dynamic metadata querying allows you to work with and analyze HCL Domino data using native data types.

Gather Connection Properties and Build a Connection String

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.

NOTE: To use the JDBC driver in an AWS Lambda function, you will need a license (full or trial) and a Runtime Key (RTK). For more information on obtaining this license (or a trial), contact our sales team.

Built-in Connection String Designer

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

java -jar cdata.jdbc.domino.jar

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

Fill in the connection properties (including the RTK) and copy the connection string to the clipboard.

Create an AWS Lambda Function

1. Download the CData JDBC Driver for HCL Domino installer, unzip the package, and run the JAR file to install the driver.

2. Create a new AWS Lambda Java Project in Eclipse using the AWS Toolkit for Eclipse. You can follow the tutorial from AWS (amazon.com).

   For this article, set the Input Type for the project to "Custom" so we can enter a table name as the input.

   👁 Creating a new AWS Lambda Java project
   
3. Add the CData JDBC Driver for HCL Domino JAR file (cdata.jdbc.domino.jar) to the build path. The file is found in INSTALL_PATH\lib\. 👁 Adding the JDBC Driver JAR file
   
4. Add the following import statements to the Java class:

   import java.sql.Connection;
   import java.sql.DriverManager;
   import java.sql.ResultSet;
   import java.sql.ResultSetMetaData;
   import java.sql.SQLException;
   import java.sql.Statement;
   

5. Replace the body of the handleRequest method with the code below. Be sure to fill in the connection string in the DriverManager.getConnection method call.

   String query = "SELECT * FROM " + input;
   
   try {
   	Class.forName("cdata.jdbc.domino.DominoDriver");
   } catch (ClassNotFoundException ex) {
   	context.getLogger().log("Error: class not found");
   }
   
   Connection connection = null;
    
   try {
   	connection = DriverManager.getConnection("jdbc:cdata:domino:RTK=52465...;Server=https://domino.corp.com;AuthScheme=OAuthPassword;User=my_domino_user;Password=my_domino_password;");
   } catch (SQLException ex) {
   	context.getLogger().log("Error getting connection: " + ex.getMessage());
   } catch (Exception ex) {
   	context.getLogger().log("Error: " + ex.getMessage());
   }
    
   if(connection != null)
   {
   	context.getLogger().log("Connected Successfully!\n");
   }
    
   ResultSet resultSet = null;
   try
   {
   	//executing query
   	Statement stmt = connection.createStatement();
   	resultSet = stmt.executeQuery(query);
   
   	ResultSetMetaData metaData = resultSet.getMetaData();
   	int numCols = metaData.getColumnCount();
   
   	//printing the results
   	while(resultSet.next())
   	{
   		for(int i = 1; i <= numCols; i++)
   		{
   			System.out.printf("%-25s", (resultSet.getObject(i) != null) ? resultSet.getObject(i).toString().replaceAll("\n", "") : null );
   		}
   		System.out.print("\n");
   	}
   }
   catch (SQLException ex)
   {
   	System.out.println("SQL Exception: " + ex.getMessage());
   }
   catch (Exception ex)
   {
   	System.out.println("General exception: " + ex.getMessage());
   }
    
   String output = "query: " + query + " complete";
   return output;
   

Deploy and Run the Lambda Function

Once you build the function in Eclipse, you are ready to upload and run the function. In this article, the output is written to the AWS logs, but you can use this is a template to implement you own custom business logic to work with HCL Domino data in AWS Lambda functions.

1. Right-click the Package and select Amazon Web Services -> Upload function to AWS Lamba. 👁 Uploading the function to AWS Lambda
   
2. Name the function, select an IAM role, and set the timeout value to a high enough value to ensure the function completes (depending on the result size of your query).
3. Right-click the Package and select Amazon Web Services -> Run function on AWS Lambda and set the input to the name of the HCL Domino object you wish to query (i.e. "ByName"). 👁 Entering the table name as input
   
4. After the job runs, you can view the output in the CloudWatch logs. 👁 The data in AWS CloudWatch (Salesforce is shown).
   

Free Trial & More Information

Download a free, 30-day trial of the CData JDBC Driver for HCL Domino and start working with your live HCL Domino data in AWS Lambda. Reach out to our Support Team if you have any questions.