Skip to content

Latest commit

 

History

History
173 lines (138 loc) · 9.03 KB

README.md

File metadata and controls

173 lines (138 loc) · 9.03 KB
Raw

Payara 5 -> Payara 6 Migration

Background

Payara 6 will be released in Q2 2002, after which Payara 5 Community Edition will not receive security updates. Payara 6 will only support Jakarta EE 10 and Java 11, so we need to upgrade all our components.

Useful links

Workarounds / fixes

slf4j bug

This has been fixed in Payara 6.2023.3.

Oracle driver

NOTE: This no longer uses the lib/ext directory.

  1. Put the oracle driver (ojdbc11-XXX.jar) in the glassfish/domains/domain1/lib directory.
  2. Also, copy (or symlink) the EclipseLink Oracle extension library from glassfish/modules/org.eclipse.persistence.oracle.jar to the glassfish/domains/domain1/lib directory.
  3. Restart Payara.

Process

We will do this in 2 phases:

  • Phase 1: move from Java 8 and JavaEE 7 (Payara 5) to Java 11 and JakartaEE 9.1 (Payara 6-Alpha)
  • Phase 2: move from JakartaEE 9.1 to JakartaEE 10 (Payara 6-Alpha 4+)

This is because JakartaEE 10 and Payara 6 have not yet been releaed.

Components

Component Java 11 JakartaEE 9.1 JakartaEE 10 New version Assigned to Check for python Update XML schemas
icat.utils N/A N/A N/A N/A ✔ N/A
icat.authentication Done Done Done 5.0.0 AK N/A N/A
icat.server Done Done Done 6.0.0 AK ✔ ✔
icat.client Done Done Done 6.0.0 AK N/A N/A
icat.lucene Done Done Done 2.0.2 AK ✔ ✔
authn.anon Done Done Done 3.0.0 AK ✔ ✔
authn.db Done Done Done 3.0.0 AK ✔ ✔
authn.ldap Done Done Done 3.0.0 AK ✔ ✔
authn.simple Done Done Done 3.0.0 AK ✔ ✔
authn.oidc Done Done Done 2.0.0-SNAPSHOT VB ✔ ✔
icat.oaipmh Done Done Done 2.0.0-SNAPSHOT VB ✔ ✔
dgw-dl-api Done Done Done 3.0.1 VB/AK ✔ ✔
ids.server Done Done Done 2.0.0-SNAPSHOT AK ✔ ✔
ids.storage-file N/A N/A N/A N/A ✔ N/A
ids.storage-test N/A N/A N/A N/A PR
ids.r2dfoo Done Done Done 2.0.1 VB ✔ ✔
dls-ids-plugin N/A N/A N/A 1.3.0 N/A
common-doi ISIS
authn.uows (isis) ISIS
isis-ids-plugin ISIS
authn.uows_clf Done Done Done 2.0.0 AK ✔ ✔
authn.ip_clf Done Done Done 5.0.0 AK ✔ ✔
clf-ids Done Done Done 5.0.0 AK ✔ N/A
ecat2 Done Done Done 5.0.0-SNAPSHOT AK ✔ ✔
icat-ansible Done N/A N/A MR N/A

Issues / Blockers

Instructions - Updating XML schemas

The XML schemas have also changed namespace. You can find any references to them by grepping for xml/ns/. These are the ones encountered so for and what they should be:

In web.xml:

<web-app
	xmlns="https://jakarta.ee/xml/ns/jakartaee"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="https://jakarta.ee/xml/ns/jakartaee https://jakarta.ee/xml/ns/jakartaee/web-app_6_0.xsd"
	version="6.0">

In persistence.xml:

<persistence
	xmlns="https://jakarta.ee/xml/ns/persistence"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="https://jakarta.ee/xml/ns/persistence https://jakarta.ee/xml/ns/persistence/persistence_3_0.xsd"
	version="3.0">

See https://jakarta.ee/xml/ns/jakartaee/ for more info.

Instructions – Phase 2

  • Change the jakartaee-api dependency to:
<dependency>
    <groupId>jakarta.platform</groupId>
    <artifactId>jakarta.jakartaee-api</artifactId>
    <version>10.0.0</version>
    <scope>provided</scope>
</dependency>
  • Change other Jakarta EE test dependencies if used:
<!-- JAX-WS -->
<dependency>
    <groupId>com.sun.xml.ws</groupId>
    <artifactId>jaxws-rt</artifactId>
    <version>4.0.0</version>
    <scope>test</scope>
</dependency>

<!-- JSON-P (replaces org.glassfish:jakarta.json) -->
<dependency>
    <groupId>org.eclipse.parsson</groupId>
    <artifactId>parsson</artifactId>
    <version>1.1.0</version>
    <scope>test</scope>
</dependency>

Instructions – Phase 1

  • First, build the component using Java 8 without making any changes. This ensures you have all the required dependencies including servers running other components needed for WSDLs or for tests.

  • Create a new branch called payara6.

  • Increment the major version number in pom.xml.

  • Change the java version in the maven-compiler-plugin. You may also need to increase the version of the maven plugin itself.

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>3.10.1</version>
    <configuration>
        <release>11</release>
    </configuration>
</plugin>

Note that we are using <release> instead of <source> and <target>. See here for why: https://maven.apache.org/plugins/maven-compiler-plugin/examples/set-compiler-release.html

  • Change the javaee-api dependency to:
<dependency>
    <groupId>jakarta.platform</groupId>
    <artifactId>jakarta.jakartaee-api</artifactId>
    <version>9.1.0</version>
    <scope>provided</scope>
</dependency>

Note: <scope>provided</scope> is correct. However, changing the scope may break some execution steps; if so fix them properly – don't remove <scope>provided</scope>.

find . -name '*.java' | xargs sed -i 's/import javax\./import jakarta./'
find . -name '*.java' | xargs sed -i 's/import jakarta\.naming\./import javax.naming./'
find . -name '*.java' | xargs sed -i 's/import jakarta\.xml\.datatype\./import javax.xml.datatype./'
find . -name '*.java' | xargs sed -i 's/import jakarta\.xml\.namespace\./import javax.xml.namespace./'
find . -name '*.java' | xargs sed -i 's/import jakarta\.xml\.parsers\./import javax.xml.parsers./'

  • Run mvn install to build the component and run the test suite. Fix any issues.

  • Test the component in Payara 6-Alpha.

  • Run mvn deploy to upload the package to the repo. Ask M.R. for credentials.