Creating a JDBC Data Source

You can create a JDBC data source to connect from your Java application. Creating a JDBC data source based on the CData JDBC Driver for Domino consists of three basic steps:

1. Add the driver JAR file to the classpath. The JAR file is located in the lib subfolder of the installation directory. Note that the .lic file must be located in the same folder as the JAR file.
2. Provide the driver class. For example:
   

   cdata.jdbc.domino.DominoDriver

3. Provide the JDBC URL. For example:
   

   jdbc:domino:URL=http://dominoserver:3002/;DatabaseScope=names;TableTypes=Tables;AuthScheme=OAuthPassword;User=MyUser;Password=MyPassword;
   
   or
   
   jdbc:cdata:domino:URL=http://dominoserver:3002/;DatabaseScope=names;TableTypes=Tables;AuthScheme=OAuthPassword;User=MyUser;Password=MyPassword;

   You can use the second format above whenever there is a conflict in your application between drivers using the same URL format to ensure you are using the CData driver. The URL must start with either "jdbc:domino:" or "jdbc:cdata:domino:" and can include any of the connection properties in name-value pairs separated with semicolons.

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 to Domino

Domino supports authenticating via either login credentials (OAuthPassword) or Microsoft Entra ID (AzureAD).

Login Credentials

Set these properties:

• AuthScheme: OAuthPassword.
• User: The authenticating Domino user's login.
• Password: The authenticating Domino user's password.

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

Microsoft Entra ID (Azure AD)

Note: Microsoft has rebranded Azure AD as Entra ID. In topics that require the user to interact with the Entra ID Admin site, we use the same names Microsoft does. However, there are still CData connection properties whose names or values reference "Azure AD".

This authentication method uses Azure Active Directory as an identity provider (IdP) to obtain a JWT token. Before a user can authenticate via Azure AD, a user with admin privileges must create a custom Azure AD OAuth application in Azure Active Directory and configure it as an IdP, as described in Creating a Custom Entra ID (Azure AD) Application.

Once the custom Azure AD application has been completed, set these properties:

• AuthScheme: AzureAD.
• InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
• OAuthClientId: The Client ID that was obtained during custom Azure AD application creation.
• OAuthClientSecret: The Client Secret that was obtained during custom Azure AD application creation.
• CallbackURL : The redirect URI that was specified during custom Azure AD application registration. For example, https://localhost:33333.
• AzureTenant: The Microsoft Online tenant being used to access data. Supply either the Tenant ID, or a value in the form companyname.microsoft.com.
  (The Tenant ID is the same as the directory ID shown in the Azure Portal's Azure Active Directory > Properties page.)