This chapter demonstrates how to install Ultipa Java SDK. Please request the latest version of ultipa-sdk-java-xxx.jar from Ultipa Support.

Java Environment

Java version 8 +

Introduce into Maven Project

Java SDKs of V4.1.0 or later version can be introduced into Maven via private repository (method A listed below) and need not to upload the sdk file, while the older versions can be introduced via method A~C.

A. Private Maven repository

• Upload the sdk file (only for versions older than V4.1.0) to private Maven repository via related management console, nexus for example;
• Add below dependencies to pom.xml:

<dependency>
  <groupId>com.ultipa</groupId>
  <artifactId>ultipa-java-sdk</artifactId>
  <version>4.0.1</version>
</dependency>

This apporach provides the conveniences of both auto transfer and download of 3rd party packages, and needs no additional operations on other servers, with the prerequisite that your organization has an environment of private Maven repository.

B. Local directory (only for versions older than V4.1.0)

• Store the sdk file under directory lib of your Maven project;
• Add below dependencies to pom.xml:

<dependency>
  <groupId>com.ultipa</groupId>
  <artifactId>ultipa-java-sdk</artifactId>
  <version>4.0.1</version>
  <scope>system</scope>
  <systemPath>${pom.basedir}/src/main/resources/lib/ultipa-java-sdk-4.0.1.jar</systemPath>
</dependency>

This approach requires developers to manually add dependencies into pom.xml for any other 3rd party packages needed by sdk.

C. Local Maven repository (only for versions older than V4.1.0)

• Execute below command and install sdk to local Maven repository:

mvn install:install-file -Dfile=D:\ultipa-java-sdk-4.0.1.jar -DgroupId=com.ultipa -DartifactId=ultipa-java-sdk -Dversion=4.0.1 -Dpackaging=jar

• Add below dependencies to pom.xml:

<dependency>
  <groupId>com.ultipa</groupId>
  <artifactId>ultipa-java-sdk</artifactId>
  <version>4.0.1</version>
</dependency>

In this approach, dependencies of 3rd party packages will be automatically transferred and downloaded. In case the Maven package is on another server, Jenkins for example, developers should also execute commands in the Jenkins server to install sdk to local Maven repository.