4 4 3 Beefalo:Installing and Managing Java

From SEPsesam
Jump to: navigation, search
Other languages:
Deutsch • ‎English

Copyright © SEP AG 1999-2019. All rights reserved.

Any form of reproduction of the contents or parts of this manual is allowed only with the express written permission from SEP AG. When compiling and designing user documentation SEP AG uses great diligence and attempts to deliver accurate and correct information. However, SEP AG cannot issue a guarantee for the contents of this manual.

Docs latest icon.png Welcome to the latest SEP sesam documentation version 4.4.3 Beefalo. For previous documentation version(s), check documentation archive.


Overview

The SEP sesam graphical user interface (GUI) is used to configure and manage SEP sesam and its environment. SEP sesam GUI is platform independent – it is based on Java and requires a Java Runtime Environment. The required Java version depends on SEP sesam version. To ensure that SEP sesam is running correctly, make sure to install and configure a supported Java version. See Java Compatibility Matrix for details.

Java is required on all systems that serve as SEP sesam Server, SEP sesam GUI client or SEP sesam Remote Device Server (RDS) when Si3 deduplication is used. Java is not required for SEP sesam Client (does not provide GUI) or for SEP sesam RDS if Si3 deduplication is not used.

The two main implementations of Java are OpenJDK and Oracle Java. As the differences between them are not that significant from the SEP sesam point of view and with Oracle announcing the end of free support for past versions of Java as well as the Oracle JDK binary no longer be free for use in production from JDK 11 on, SEP sesam introduced support for OpenJDK LTS (long term support) distributions that are available free of charge. Note that HiDPI displays are supported with the relevant Java version.

Prerequisites

  • On Windows, you may need Administrator privileges to install Java. Make sure to install Java from the provided Java download link before you install SEP sesam packages.
  • On Linux, all commands have to be executed as a root user or as an administrative user with the sudo command prefixed.
  • It is recommended to disable your firewall before starting the installation.
  • Make sure that system requirements for installing Java are met.
  • If you already have Java installed and you want to use multiple Java versions, make sure to configure the required version as explained in the section Setting preferred Java version for SEP sesam. If you do not need multiple Java versions, remove the Java installations not required by SEP sesam.

The following procedures show how to install different Java versions on Windows and Linux. SEP sesam recommends installing the SEP sesam Java distribution as described in the following section.

Installing SEP sesam Java distribution

How you install Java depends on the operating system as well as on the version you intend to install; you can install OpenJDK or Oracle Java. After installing the required Java version, you may have to enable and configure it.

Windows

Windows download and installation of OpenJDK is easy and pretty straightforward if you use the SEP sesam Java download: Download the Java directly from the provided link, then run the installer – and you are set. Note that you need to specify the Java path during the installation of SEP sesam.

Linux

For SEP sesam 4.4.3 Beefalo, the Java included in the Linux distribution is used, thus no additional steps are needed. However, if you opt for another Java version download then you have to download and install Java following the instructions offered by your Java provider.

Installing OpenJDK

If you choose not to use the OpenJDK version provided by SEP sesam, download the required version either from Red Hat or from the GitHub community.

OpenJDK on Windows using the zip archive

To install OpenJDK on Windows using the zip archive, you need to download and unzip the archive.

  1. Sign in with the Administrator account and download the required version either from Red Hat or from the GitHub community. Then extract the zip file into a folder, typically C:\Program Files\Java\. A jdk-<no> folder is created (where the number depends on your installed version, for example, jdk-11) where the bin folder is a direct sub-folder.
  2. Set the Java path in one of two ways:
    1. Preferably specify the Java path during the installation of SEP sesam.
    2. Select Control Panel -> System -> click Advanced -> Environment Variables. Then set JAVA_HOME: Under System Variables, click New and enter the variable name as JAVA_HOME. Enter the variable value as the installation path of the JDK (without the bin sub-folder). Click OK and Apply Changes.

OpenJDK on Linux

There are multiple ways of installing Java on Linux. Make sure that you select the download version according to your operating system and to execute all commands as a root user or as an administrative user with the sudo command prefixed. Verify that your downloaded Java version and your Linux version are compatible; for example, to install OpenJDK11 on Red Hat Enterprise Linux, you must be running at least Red Hat Enterprise Linux 6.

Once you have downloaded your version, use the following commands to install Java. For detailed instructions, refer to the respective Linux documentation.

Installing on RHEL
Log in with administrator access and download the required version. Install the OpenJDK 11 package by running the command:
sudo yum install java-11-openjdk-devel

For details, check the RHEL documentation and the article Migrating from Oracle JDK to OpenJDK on Red Hat Enterprise Linux: What you need to know.

Installing Java JDK 11 from RPM
Make sure you change the version number to correspond to your downloaded version.
rpm -ivh jdk-<version>

For example:

# rpm -ivh jdk-11.0.1_linux-x64_bin.rpm
Installing on Debian and Ubuntu
Use the below command to install OpenJDK using the package manager from the default repository. The command will install JDK and JRE; you can also choose to install only the JRE package.
sudo apt-get install openjdk-11-jre openjdk-11-jdk

Installing Oracle Java

Windows

Download the Oracle Java directly from the provided link, then run the installer – and you are set. Note that you need to specify the Java path during the installation of SEP sesam. For detailed instruction on installing Oracle Java, see Installation of the JDK on Microsoft Windows Platforms.

Linux

Linux download and installation of Oracle Java depend on the type of installation packages: either it is an archive binary file (.tar.gz) or an RPM binary file (.rpm) for Linux platforms, such as Red Hat and SuSE. Thus you must ensure that your Java installation type (.tar.gz or .rpm) matches the SEP sesam installation package; if the SEP sesam Server is going to be installed as an .rpm package, Java must also be installed as .rpm. The following example is for installing Oracle Java .rpm. For installing the JDK for Linux from .tar.gz and for more information on Oracle Java on Linux, refer to Installation of the JDK on Linux Platforms.

  1. Download the required Oracle Java JDK rpm binary package.
  2. Install Java using the rpm command. Make sure you change the version number appropriately. rpm -ivh jdk-<version>.rpm
  3. For example, to install Oracle Java JDK 11 (LTS):

    rpm -ivh jdk-11.0.3_linux-x64_bin.rpm
    
  4. Then exit the root shell (reboot is not required). By default, Java JDK is installed in /usr/java/ directory. To install Oracle JDK to a custom directory, use rpm -ivh –prefix=/<path>/ rpmfile command. Once installed, you can delete the .rpm file.
  5. Now you need to set up JAVA environment variables.

Verifying Java version

To verify that your Java version is installed correctly, open up the command prompt and enter:

java -version

Setting preferred Java version for SEP sesam

In case you have installed multiple Java versions on Windows, you may have to modify the SEP sesam Server configuration file <sesam_install_dir>\var\ini\sm.ini to enable SEP sesam to use the specified Java version. The SEP sesam Server can work with a Java version other than the operating system's default Java version.

sm.ini includes a [JAVA] configuration section which specifies the path to the Java version detected during the installation of SEP sesam. You may enter another path for your selected Java version, for example, to configure SEP sesam to use a newly installed version of Java 11 instead of older Java 8.

  1. Open and modify the configuration file as follows:
  2. [JAVA]
    java_exit_on_fail=no
    java_interpreter=C:\Program Files\Java\jre1.8.0_162\bin\java.exe
    

    change to:

    [JAVA]
    java_exit_on_fail=no
    java_interpreter=C:\Program Files\Java\jdk-11.0.2\bin\java.exe
    
  3. If you are changing the Java path on the SEP sesam Server or SEP sesam device server, you have to restart the SEP sesam services by using the command sm_main stop:
  4. C:\Program Files\SEPsesam\bin\sesam>sm_main stop 
    

    followed by the sm_main start command:

    C:\Program Files\SEPsesam\bin\sesam>sm_main start
    

    and then close and reopen the SEP sesam GUI.

Alternatively, use the command sm_setup set_java_path -f "<Java_path>" to modify the sm.ini configuration. In our example, the command is:

C:\Program Files\SEPsesam\bin\sesam>sm_setup set_java_path -f "C:\Program Files\Java\jdk-11.0.2"
Set java value in 'C:\ProgramData\SEPsesam\var\ini\sm.ini'
[JAVA]
java_interpreter=C:\Program Files\Java\jdk-11.0.2\bin\java.exe
java_version=11.0.2
ignore_java_home=yes