1. Java Agent Setup Guide

Owned by Jenni Wallin
Last updated: May 15, 2023 by Former user (Deleted)

This document forms the setup guide for the Java development environment that users will be required to set up in order to successfully run the Java agent.

The guide will cover the setup of all pre-requisites as well as the setup of the development environment with ANT or Gradle.

These are required to be installed before hand:

  • Java Development Kit (version 1.8)

  • A project build tool such as ANT or Gradle
  • cURL Tool


This chapter includes the following sections:

1.1 Setup using ANT

1.2 Setup using Gradle


Note!

The  Platform must be installed prior to the installation of the development environment.

Installing JDK

Download and install the Java Development Kit (JDK) version 1.8 by following the installation guide for your particular operating system.

Once it is done, please ensure that the Java command is added in the system path by checking with the command itself.

Example - Using java command on a Linux OS to check if the JDK is installed properly.

$ java -version
java version "1.8.0_161"
Java(TM) SE Runtime Environment (build 1.8.0_161-b12)
Java HotSpot(TM) 64-Bit Server VM (build 25.161-b12, mixed mode)


Installing cURL

When using Windows as the Java development environment, the cURL tool will not be included by default. The cURL tool is utilized by the project's scripts and is required to build successfully in Windows.

Download and install the cURL tool for windows.

To ensure that the cURL tool is working, please check with the command itself.

Example - Using curl command on Windows to check if curl is installed properly.

C:\Program Files (x86)\curl\bin>curl.exe -V
curl 7.61.0 (x86_64-pc-win32) libcurl/7.61.0 OpenSSL/1.1.0h (winSSL) zlib/1.1.11 brotli/1.0.5 WinIDN libssh2/1.8.0 nghttp2/1.32.0
Release-Date: 2018-07-11
Protocols: dict file ftp ftps gopher http https imap imaps ldap ldaps pop3 pop3s rtsp scp sftp smb smbs smtp smtps telnet tftp
Features: AsynchDNS IDN IPv6 Largefile SSPI Kerberos SPNEGO NTLM SSL libz brotli TLS-SRP HTTP2 HTTPS-proxy MultiSSL

Once the cURL tool is successfully running in Windows, curl.exe will need to be made available for the user to run from the command prompt, much like the curl command in Linux or Mac OS

The following are steps to make curl.exe available with a command on the command prompt, by adding it to the system path:

  1. Open the Windows 10 start menu and type in environment into the search bar.
  2. Select the menu item Edit the System Environment Variables.
  3. A System Properties window will appear. From this window, select the Environment Variables button.
  4. Select the path variable and click on the Edit button
  5. Select the Add button and paste the full path of the curl.exe file location into the path variable.
  6. Click Ok and open a new command prompt window to allow the new system path to take into effect.
Next:

1.1 Setup using ANT