How to use the Java API

Setup the environment to work with the Integration Server Java API.

Prerequisite:

Important

To access the references for the Integration Server Java API classes and methods, please see the file JavaApiDoc.jar, located in the JavaApi\Docs folder in the Integration Server installation folder. For example, C:\Program Files\Altitude\Altitude uCI 8\Altitude Integration Server\JavaApi\Docs. You can also download the file through the link javaApiDoc.zip.
  1. Install JDK 25 or higher.

    Note

    The Java API sample, available with the Integration Server and uAgent Web setup, was developed using Apache Netbeans 27, and compiled with JDK 25.
  2. Add files to the CLASSPATH. Add the following .jar files to the environment variable CLASSPATH:
    • commons-beanutils-1.11.0.jar
    • commons-configuration2-2.12.0.jar
    • commons-jxpath-1.4.0.jar
    • commons-lang3-3.19.0.jar
    • commons-logging-1.3.5.jar
    • commons-text-1.14.0.jar
    • gmbal-4.1.0.jar
    • gmbal-api-only-4.1.0.jar
    • jakarta.activation-2.0.1.jar
    • jakarta.activation-api-2.1.4.jar
    • jakarta.jws-api-3.0.0.jar
    • jakarta.xml.bind-api-4.0.4.jar
    • jakarta.xml.soap-api-3.0.2.jar
    • jakarta.xml.ws-api-4.0.2.jar
    • jaxb-core-4.0.6.jar
    • jaxb-runtime-4.0.6.jar
    • jaxws-rt-4.0.3.jar
    • log4j-api-2.25.2.jar
    • log4j-core-2.25.2.jar
    • log4j-slf4j2-impl-2.25.2.jar
    • saaj-impl-3.0.4.jar
    • slf4j-api-2.0.17.jar
    • stax-ex-2.1.0.jar
    • streambuffer-2.1.0.jar
  3. Setup the log4j configuration file. See the following links to know how you can setup the log4j configuration file:
  4. Add a reference to the file JavaApi\log4j.xml.
  5. Add or replace references to configuration packages and configuration files. If you are developing a new application using the Integration Server Java API, do the following:
    • Add a reference to the package org.apache.commons.configuration2.
    • Add the following line to the beginning of your application:

      Configuration config = (new Configurations()).xml("config.xml");

    If you are upgrading an existing application to a newer version of the Integration Server Java API, do the following:
    • Replace org.apache.commons.configuration with org.apache.commons.configuration2.
    • Replace

      Configuration config = new XMLConfiguration("config.xml");

      with

      Configuration config = (new Configurations()).xml("config.xml");