Configure the Java environment
Java-based components require a Java virtual environment (JVM) to run. This includes the following components and plugins:
- Control-M plugin
- E4JMS (TIBCO EMS) plugin
- IBM i plugins
- JMX plugin
- Publisher plugin
- REST API plugin
- REST Extractor plugin
- SSO Agent
This topic walks you through the files and setup required before you start configuring Java-based components.
Before you begin, check that you have the complete set of Netprobe files on the machine where you are running the Java-based plugin.
These files are bundled in the Netprobe binary package, which you can download from ITRS Downloads. For more information on the files provided, see Files included in the Netprobe package.
In addition, check that you have one of the supported Java Runtimes or Java Development Kits on the machine. These packages are available from their respective vendor sites.
Note: The supported Java version may be different, depending on the plugin you plan to run. For guidance on supported versions, see Application and plugin specific information in Geneos Compatibility Matrix.
For Java installation typically does not require the additional configuration steps outlined in this topic. Please proceed only when you encounter errors with your Java-based plugin.platforms, the supported
Certain plugins require additional vendor-specific files to run. You must obtain these from a licensed distribution, as ITRS Group Ltd does not make these files available as part of the Netprobe for this reason. In these cases, refer to the plugin user guide for the required vendor-specific files.
Java virtual machine parameters
The Netprobe launches the Java virtual machine (JVM) with the following parameters:
||This parameter contains a list of third-party and user-defined
classes that the JVM needs for running Java
applications. The Netprobe uses all the JAR files
found in the current directory, as well as the on the
This parameter provides the path to the native libraries that the JVM requires.
||This parameter sets the Java home of the embedded JVM.|
Once the Netprobe starts, you can find and verify the values of the parameters in the Netprobe log.
Disabling TLS or ciphers
To manually disable older TLS versions or other weak ciphers for Java applications, add the cipher you want to disable to the
jdk.tls.disabledAlgorithms property of the java.security file. For example, adding
CBC to the list disables the TLSv1 and TLSv1.1 protocols, and the CBC ciphers.
#Example: jdk.tls.disabledAlgorithms=TLSv1, TLSv1.1, CBC
- For Java 8, it is located in
- For Java11, it is located in
For more information on TLS ciphers, see TLS ciphers in Secure Communications.
Set the environment variables
Once the required files are in place, the next step is to set the environment variables so that the Netprobe can locate them.
Note: Beginning Netprobes version 4.12.0, you only need to set the
JAVA_HOME environment variable. From the information carried by that variable, the Netprobe can look for other JAR and library files on its own. For more information on this behaviour, see Configure the Java environment.
Locating resource files for Netprobe versions 4.12.x
Beginning Netprobes version 4.12.0, the Netprobe attempts to locate JAR and library files based on the directory set in
With this behaviour in place, the following environment variables become optional:
Instead, the Netprobe searches for the JAR and library files in the following manner:
- The JAR files are searched for in the
/jarsdirectory in the Netprobe binary directory.
launchpad.dll(for ) or
launchpad.so(for and similar platforms) are searched for in the Netprobe binary directory.
jvm.dll(for ) or
libjvm.so(for and similar platforms) are searched for based on the value of
Caution: The 4.12.x Netprobe follows the OracleJDK and OpenJDK 8 structure when searching for
libjvm.so. If you are running OpenJDK 11, then you need to set the corresponding environment variable. For guidance, see Configure the Java environment.
If the Netprobe fails to locate the files in this method, then it attempts to search the files using the optional environment variables.
Note: If you are running a plugin that requires vendor-specific JAR files, set
GENEOS_JARS to point to the directory containing them. For guidance, see Configure the Java environment.
The Netprobe needs to create a Java virtual machine from which to load and run Java-based plugins or processes. To do so, it must locate the requisite library file found in the Java runtime installation directory:
libjvm.sofor and similar platforms
To direct the Netprobe to the library file, modify the environment variable accordingly:
LD_LIBRARY_PATHfor Solaris and platforms.
LIB_PATHfor AIX platforms.
When modifying the path environment variable, follow these guidelines:
- The path environment variable entry must come before any other entry.
- Do not copy the library file directly into the current working directory. The library file relies on relative paths to locate additional resources. If it is moved to the current working directory, then the additional resources will no longer be available, and the Netprobe will fail to create a Java virtual machine.
Caution: Geneos components use the
JAVA_HOME environment variable to point to the Java runtime installation directory. It does not use the
JRE_HOME environment variable.
Via command line
You can set the environment variable on the command line:
set JAVA_HOME=C:\Program Files (x86)\Java\jdk1.8.0_211\jre set PATH=%JAVA_HOME%\bin\client;%PATH%
Alternatively, to prevent conflicts with other Java applications,
you can set the Netprobe registry keys, instead. The path to the Netprobe registry is
should be added in the same location as the other
Netprobe registry keys:
JAVA_HOME— points to the Java runtime folder. For example,
C:\Program Files (x86)\Java\jdk1.8.0_211\jre.
JVM_LIBPATH— contains the absolute path of the
jvm.dllfile. For example,
C:\Program Files (x86)\Java\jdk1.8.0_211\jre\bin\client\jvm.dll.
Note: If you set the registry keys, then the Netprobe ignores the values set in the environment.
You can set the environment variables on the command line:
setenv JAVA_HOME /usr/java/jdk1.8.0_211/jre setenv LD_LIBRARY_PATH $JAVA_HOME/lib/sparc/client setenv PATH $JAVA_HOME/bin:$PATH
You can set the environment variables on the command line:
setenv JAVA_HOME /usr/java/jdk1.8.0_211/jre setenv LD_LIBRARY_PATH $JAVA_HOME/lib/amd64/server setenv PATH $JAVA_HOME/bin:$PATH
You can specify the directory where the Netprobe accesses the Geneos JAR files through the
GENEOS_JARS environment variable.
If a plugin requires vendor-specific JAR files, then use
GENEOS_JARS to point to that directory, as well.
On , , and
Onand similar platforms, you can set the environment variable on the command line:
setenv GENEOS_JARS /jars
Note: This setting is particularly useful when a plugin is expected to connect to an application and needs multiple JAR files to be able to connect to it, as it is not always feasible to copy additional JAR files into the current working directory.
Additional directories to shared libraries
To specify additional directories for locating libraries used by the plugin,
GENEOS_LIBS environment variable.
After you set the environment variables, restart the Netprobe.
After you have configured the Java environment, you may proceed to setting up your Java-based plugin:
If you encounter errors when configuring your Java environment, see Troubleshoot the Java configuration.