Daily Archives: September 28, 2021

Sakai 22 moving to Java 11

(This was originally from Earle Neitzel on the Sakai dev-list)

The time has finally come for Sakai to adopt and move to Java 11.

A big part of this decision is inline with the libraries that Sakai uses, once all the significant libraries have transitioned to running in a newer JDK Sakai itself becomes eligible for the same. Sakai software (like most software) is like lego’s and the blocks all need to have the same shape and size in order to work together. So once all the fundamental blocks (like spring, hibernate, elasticsearch, ignite, server side UI frameworks) support a newer JDK, then Sakai can look at adopting that JDK.

History
JDK 5 Dec 14 2006 (approx)
JDK 6 Feb 20 2012 SAK-20908
JDK 7 Oct 27 2014 SAK-28016
JDK 8 March 29, 2015 SAK-25903
JDK 11 Sept 24 2021 SAK-33595

In the past, it was customary to limit newer language syntax in order to preserve compatibility when merging changes to previous versions. I propose we do this for at least 1 Sakai version which would mean once the 23 branch is cut then we could allow newer syntax. I would also revisit this at that time to see if it should be extended to 2 Sakai versions. (Most IDE’s will allow you to set the syntax level to help prevent you from using newer syntax)

Jakarta package name
So in conjunction upgrading to jdk 11, jdk 9+ removed much of the javax namespace (aka JEE) it means that many of these packages are now separate libs which need to be included. On top of that Oracle has given the Java EE to Eclipse with the restriction that they cannot use the word “Java” hence the need to rename the packages to Jakarta. Given many of our libs are still using the javax package names we can use jakarta libs that keep the package name space (like activation and validation) but newer jakarta packages are changing the package names as well this last part is causing some issues as some of the libs are still on versions using the javax package name. I propose that until Sakai is on newer libs that support the newer package names that we stay on the javax namespace. This means that i reverted a recent contribution SAK-45950 by David Horrowitz to stay on the javax package name, I apologize but believe it’s the right thing to do at this time.

Building Sakai with JDK 11
The source can only be built using JDK 11 moving forward. So you will need to download and use a respective JDK. I propose that Sakai standardize on the OpenJDK project as all other projects use that project as a base and should ensure our compatibility with other JDK flavors.

This project https://sdkman.io/ makes that task simple.

Running Sakai with JDK 11
Here will list the options we will need to use to run Sakai in JDK 11.
In your setenv.(sh|bat) you will need to add the following lines to JAVA_OPTS or CATALINA_OPTS:
–add-exports=java.base/jdk.internal.misc=ALL-UNNAMED \
–add-exports=java.base/sun.nio.ch=ALL-UNNAMED \
–add-exports=java.management/com.sun.jmx.mbeanserver=ALL-UNNAMED \
–add-exports=jdk.internal.jvmstat/sun.jvmstat.monitor=ALL-UNNAMED \
–add-exports=java.base/sun.reflect.generics.reflectiveObjects=ALL-UNNAMED \
–add-opens jdk.management/com.sun.management.internal=ALL-UNNAMED \
–illegal-access=permit

Next you will want to select a Garbage Collector to use this may depend on the JDK that your using. See the following page for some info https://docs.oracle.com/en/java/javase/11/gctuning/available-collectors.html