Domino Data Lab Java Client

Domino Data Lab Java Client is a library that wrappers the REST API calls for Domino using a Java native HTTP client.

Requirements

To use this library you will need the following:

• JDK 11+
• Domino API Key to an active Domino instance

Usage

The library is available on Maven Central for use in Maven/Gradle/Ivy etc.

Apache Maven (javax):

<dependency>
    <groupId>com.ksmpartners</groupId>
    <artifactId>domino-java-client</artifactId>
    <version>${domino.version}</version>
</dependency>

Apache Maven (jakarta):

<dependency>
    <groupId>com.ksmpartners</groupId>
    <artifactId>domino-java-client</artifactId>
    <version>${domino.version}</version>
    <classifier>jakarta</classifier>
</dependency>

Gradle:

implementation group: 'com.ksmpartners', name: 'domino-java-client', version: '${domino.version}'

Example: Using the library is simple, you just need a Domino API Key and URL.

import com.dominodatalab.api.invoker.ApiClient;
import com.dominodatalab.api.invoker.ApiException;
import com.dominodatalab.api.model.DominoCommonUserPerson;
import com.dominodatalab.api.rest.UsersApi;
import com.dominodatalab.client.DominoApiClient;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;

public class DominoTest {

    private static final String API_URL = "https://domino.cloud.com/v4";
    private static final String API_KEY = "74b86eaa8c3e8310748de7714926b0b6a3866d8eb8c493fdf2d8fed7a520b842";

    public static void main(String... args) {
        try {
            // initialize client with key
            final ApiClient client = DominoApiClient.createApiClient();
            client.updateBaseUri(API_URL);
            client.setRequestInterceptor(builder -> builder.setHeader("X-Domino-Api-Key", API_KEY));

            // call the get current user API
            UsersApi api = new UsersApi(client);
            DominoCommonUserPerson user = api.getCurrentUser();

            // print response as JSON
            ObjectMapper mapper = DominoApiClient.createDefaultObjectMapper();
            String result = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(user);
            System.out.println(result);
        } catch (ApiException | JsonProcessingException e) {
            e.printStackTrace();
        }
    }
}

Resulting JSON output:

{
  "firstName": "Homer",
  "lastName": "Simpson",
  "fullName": "Homer Simpson",
  "id": "6124ffbfa7db86282dde302a",
  "userName": "hs12345",
  "email": "homer.simpson@springfield.org"
}

Build and Test

Build the project with Apache Maven:

$ mvn clean package

Install it to your local Maven repository with:

$ mvn install

Running Integration Tests

There are multiple test suites defined under this project. The default tests that run when running mvn test are the tests tagged "Unit".

There are two other groups of tests: "Integration" and "Stateful". The Stateful tests are designed to return to the initial state, but if the tests fail or get shut down in the midst of running, the pre-condition will no longer be met. It will require logging into Domino and reconfiguring whatever project configuration, etc. to match the pre-condition. For this reason, Stateful tests are always excluded by default since they incur changing the state of Domino away from the pre-condition assumption.

These tests are configured to use a particular account for a particular instance of Domino that has been set up with certain projects and configuration. Running the integration tests requires configuration of specific secrets under the src/test/resources/application.properties file.

The tests tagged as Integration can be run with the following command:

$ mvn -Dtests="Integration" test

To run all tests in the project including the tests tagged as Stateful:

$ mvn -Dtests="any()" -DexcludeTests="" test

Release

• Run mvn versions:set -DgenerateBackupPoms=false -DnewVersion=5.5.1 to update all modules versions
• Commit and push the changes to GitHub
• In GitHub create a new release titled 5.5.1 to tag this release
• Run mvn clean deploy -Prelease to push to Maven Central

(Replace 5.5.1 in the steps above with the actual SEMVER release number.)

"Slim" Domino API

This is a subset of the v4 API currently used by KSM. The endpoints used are listed in src/conf/domino-internal-api-usage.csv. The src/conf/slim-api.json file is created from copying from the src/conf/domino-openapi.json file and filtering for the endpoints listed in the CSV. This can be regenerated and compiled using the following commands:

• Run ./src/conf/generate-slim-api.py > ./src/conf/slim-api.json to update the slim spec file from the CSV and source spec
• Run mvn compile to ensure the slim spec file is valid

License

Licensed under the MIT license.

SPDX-License-Identifier: MIT

Copyright

Domino and Domino Data Lab are © 2023 Domino Data Lab, Inc. Made in San Francisco.