Configuring an External JRE

A guide to how to set up the Akana Platform to use an external JRE rather than the version included with installation.

Table of Contents

Introduction

With regard to JRE, you can choose to install the Akana Platform:

  1. With embedded JRE: There is one ZIP file for Windows and one for Linux. For example, for 2020.2.2, the file for Windows is api-platform-win-jre-2020.2.2.zip. For information about the bundled JRE version, go to the System Requirements doc. Then, in the Akana Platform Host section, check the JRE version information.
  2. Without embedded JRE: There is one ZIP file for all platforms, including Windows and Linux. For example, for 2020.2.2, the file is api-platform-no-jre-2020.2.2.zip. In this scenario, you must provide a compatible Java version and update your platform installation to point to your Java version.

If you want to use an external JRE rather than the bundled JRE, choose the second option.

Supported JRE version

For information about the Java version compatible with your Akana Platform version, refer to the applicable System Requirements document: go to the System Requirements doc.

Note: The Akana Platform was tested with the Java version specified in the System Requirements document for the version. You can configure the same version as an external JRE. Later updates to the same version are probably compatible but are not tested/guaranteed. Do not use a version earlier than the supported version.

Set JAVA_HOME environment variable

If you install a version of the Akana Platform, with bundled JRE, the Akana Platform does not use the JAVA_HOME environment variable to determine the JRE version. Instead, it uses the bundled JRE version.

If you want to use an external JRE, make sure you installed the version without bundled JRE. In this scenario, the Akana Platform uses the JRE version specified in the JAVA_HOME environment variable. Make sure that JAVA_HOME is set correctly to the location of your external JRE version.

Setting JAVA_HOME is all that's needed.

Save the keystore/truststore and update the path

As a standard part of installation, you'll also need to update the com.soa.security configuration settings for the external JRE version. For instructions, see Saving the keystore/truststore and updating the path (install doc).