Connecting Your Application to InterSystems IRIS Cloud Document

Add the InterSystems Cloud Document driver, intersystems-document-version.jar, as a dependency to your project.

On the operating system command line, issue the following command to add the X.509 certificate to your keystore, supplying a keystore password and confirming Trust this certificate? [no]: yes as requested:

keytool -importcert -file path-to-cert/cert-file.pem -keystore keystore.jks

Then, in the directory containing the Java file in which you are coding the connection, create a configuration file named SSLConfig.properties and includes these properties:

trustStore=path-to-keystore/keystore.jks
trustStorePassword=keystore-password

Create a main method and import the com.intersystems.document.* libraries. Then, create a DataSource object and set its fields to the appropriate connection values as indicated in the example. Be sure to also set the connection security level to 10.

After setting the parameters for the server connection, call preStart() to initialize a pool size, then call getConnection() to create the connections. Be sure to close the connection with close() when you are finished with it.

You can copy the following template code below:

import com.intersystems.document.*;

public class JDBCConnection {
    public static void main (String[] args) throws Exception {
        DataSource pool = DataSource.createDataSource();
        pool.setServerName("???");   // replace ??? with the hostname of your deployment
        pool.setPortNumber(???);     // replace ??? with the port number of your deployment
        pool.setDatabaseName("???"); // replace ??? with the namespace specified by your deployment
        pool.setUser("SQLAdmin");
        pool.setPassword("------");  // enter the password you created for the deployment
        pool.setConnectionSecurityLevel(10);
        
        pool.preStart(10);
        pool.getConnection();
        System.out.println("Connection created");
        
        // use the connection here
        
        pool.close()
    }
}

Add the Cloud Document NuGet package, InterSystems.Data.Document.version.nupkg, as a dependency to your project.

Install the X.509 certificate using the instructions for your platform, below. (Both Windows and UNIX/Linux systems provide several ways to install certificates.)

• On Windows, open a Command Prompt window and enter the following command to add the certificate to the Trusted Root Certification Authorities\ store under Current User:

  certutil -user -addstore Root path-to-certificate\certificate-file.pem 
  

  

• On the UNIX or Linux command line, follow these steps:

  1. Enter the following command to install the Dotnet Certificate Tool, dotnet-certificate-tool (see https://github.com/gsoft-inc/dotnet-certificate-toolOpens in a new tab):

     dotnet tool install --global dotnet-certificate-tool
     

     

  2. Use the tool to add the certificate to the Root store under CurrentUser (be sure to include --store-name Root as shown):

     certificate-tool add --cert path-to-certificate\certificate-file.pem --store-name Root
     

     
     Note:

     If the certificate is not in PEM format, use the appropriate flag in place of --cert; if the certificate is password-protected, include the --password flag. For more information, see the README file on GitHub.

Import the driver by specifying using InterSystems.Document; at the top of your file. Then, create a DataSource object and set its fields to the appropriate connection values as indicated in the example below. Finally, call GetConnection() to create the connection. Be sure to close the connection with Close() when you are finished with it.

You can copy the following template code below:

using InterSystems.Document;

DataSource ds = DataSource.CreateDataSource();

string server = "???";    // replace ??? with the hostname of your deployment
string port = "???";      // replace ??? with the port number of your deployment
string ns = "???";        // replace ??? with the namespace specified by your deployment
string user = "SQLAdmin";
string pwd = "----";      // enter the password you created for the deployment
string connectionString = $"Server={server}; Port={port}; Namespace={ns}; User ID={user}; Password={pwd}; SSL = true";

try
{
    ds.SetConnectionString(connectionString);
    Connection connection = ds.GetConnection();
    
    // use the connection here
    Console.WriteLine("Made connection");
    
    ds.Close();
} catch (Exception e)
{
    Console.WriteLine(e.Message);
}