REST Client

A java-based REST Client for KumoScale software is provided to perform most API tasks. This client can either be run through the command-line or through a program such as NetBeans™ IDE or IntelliJ™.

Apache Maven™ Installation

Apache Maven must be installed and configured in order to run the REST Client through the command-line. Failure to configure Maven properly will result in an inability to run the KumoScale REST Client.

Note: Java SE Development Kit must be installed on your System in order to run Apache Maven. Ensure the JAVA_HOME environment variable is set and points to your JDK installation before installing Maven.

 

To install and configure Apache Maven for Linux Systems:

  1. Download the appropriate Apache Maven binary archive .
  2. Extract the files into the desired location.
  3. Use the following commands in the command line to configure Maven:
    1. export M2_HOME=[location you extracted Maven - e.g /usr/local/maven/apache-maven-3.3.9]

      export M2=$M2_HOME/bin

      export PATH=$M2:$PATH

      export MVN_REP=[your Maven repository path - e.g. /root/.m2/repository]
  4. Confirm the Maven installation with the following command:
    1. mvn -v

 

To install and configure Apache Maven for Windows Systems:

  1. Download the appropriate Apache Maven binary archive.
  2. Extract the files into the desired location.
  3. From the Control Panel, access System.
    1. Click Advanced System Settings.
    2. Your System may request System administrator access.
  4. The System Properties window opens. Under the Advanced tab, click the Environment Variables... button.
  5. From the open Environment Variables window,
    1. Click New... under the System Variables table. A dialog box opens.
    2. Enter in M2_HOME as the Variable name and the location you extracted Maven (for example, C:\Program Files\apache-maven-3.3.9) as the Variable value, then click OK.
    3. Click New... under the System variables table. A dialog box opens.
    4. Enter in M2 as the Variable name and the Maven /bin folder location (for example, C:\Program Files\apache-maven-3.3.9\bin) as the Variable value, then click OK.
    5. Click New... under the System variables table. A dialog box opens.
    6. Enter in PATH as the Variable name and the following as the Variable values: the location you extracted Maven (for example, C:\Program Files\apache-maven-3.3.9) and the location of your Java installation (for example, C:\Program Files\Java\jre1.8.0_121), separated by a semicolon. Click OK when done.
    7. Click New... under the System variables table. A dialog box opens.
    8. Enter in MVN_REP as the Variable name and the local Maven repository folder location (located under /root/.m2/repository for Linux or C:\Users\(user name)\.m2\repository for Windows) as the Variable value, then click OK.
    9. Click OK, then OK, and exit out of the Control Panel.
  6. Apache Maven is now configured and ready for use.

Next: Error Code Descriptions