Developer Guide for the Common Data Service Client

This library provides a client for using the Common Data Service in the Acumos machine-learning platform. It depends on many Spring libraries. This document offers guidance for both client developers and client users (developers who want to use the client in their Java projects).

Maven Dependency

The client jar is deployed to these Nexus repositories at the Linux Foundation:

<repository>
        <id>snapshots</id>
        <url>https://nexus.acumos.org/content/repositories/snapshots</url>
</repository>
<repository>
        <id>releases</id>
        <url>https://nexus.acumos.org/content/repositories/releases</url>
</repository>

Use this dependency information, ideally with the latest version number shown in the release notes:

<dependency>
        <groupId>org.acumos.common-dataservice</groupId>
        <artifactId>cmn-data-svc-client</artifactId>
        <version>1.x.x-SNAPSHOT</version>
</dependency>

Building and Packaging

As of this writing the build (continuous integration) process is fully automated in the Linux Foundation system using Gerrit and Jenkins. This section describes how to perform local builds for development and testing.

Prerequisites

The build and test machine needs the following:

1. Java version 1.8
2. Maven version 3
3. Connectivity to Maven Central to download required jars

Use maven to build and package the client jar using this command:

mvn package

Unit tests are run with an in-memory Apache Derby database.

Client Usage Example

A Java class named “BasicSequenceDemo” demonstrates use of the client. Please browse for this file in the client project test area using this link: BasicSequenceDemo.java.