From 022e4107c9baf3452c3834e78c1094c3bb0db747 Mon Sep 17 00:00:00 2001
From: Guus der Kinderen <guus.der.kinderen@gmail.com>
Date: Mon, 4 Nov 2024 20:40:09 +0100
Subject: [PATCH] Upgrade Hazelcast to 5.5.0

This upgrades the Hazelcast library used by this plugin from 5.3.7 to 5.5.0

As a result, the minimum required version of Java now is 17.

This plugin now also adopted a new versioning scheme: the version number now reflects the version of the Hazelcast library that is in use.

fixes #101
---
 changelog.html                              |  9 +++-
 classes/hazelcast-cache-config.xml          |  2 +-
 classes/hazelcast-local-config.template.xml | 12 ++---
 plugin.xml                                  |  2 +-
 pom.xml                                     | 20 ++++++++-
 readme.html                                 | 49 +++++++++++++++++----
 6 files changed, 72 insertions(+), 22 deletions(-)

diff --git a/changelog.html b/changelog.html
index d519dce43..99b758544 100644
--- a/changelog.html
+++ b/changelog.html
@@ -44,6 +44,13 @@ <h1>
 Hazelcast Clustering Plugin Changelog
 </h1>
 
+<p><b>5.5.0 Release 1</b> -- (To be determined)</p>
+<ul>
+    <li>Minimum Java requirement: 17</li>
+    <li>Adopted a new versioning scheme: the version number now reflects the version of the Hazelcast library that is in use.</li>
+    <li>[<a href='https://github.com/igniterealtime/openfire-hazelcast-plugin/issues/101'>Issue #101</a>] - Upgrade to Hazelcast 5.5.0</li>
+</ul>
+
 <p><b>3.1.0</b> -- November 5, 2024</p>
 <ul>
     <li>[<a href='https://github.com/igniterealtime/openfire-hazelcast-plugin/issues/105'>Issue #105</a>] - Maximum cache size (in bytes) incorrectly reported</li>
@@ -58,7 +65,7 @@ <h1>
 <ul>
     <li>[<a href='https://github.com/igniterealtime/openfire-hazelcast-plugin/issues/97'>Issue #97</a>] - Compatibility issue with Openfire 4.9.0</li>
     <li>[<a href='https://igniterealtime.atlassian.net/browse/OF-2792'>Issue OF-2792</a>] - Cache summary page shows wrong stats when using Clustering</li>
-    <li>[<a href='https://github.com/igniterealtime/openfire-hazelcast-plugin/issues/59'>Upgrade to Hazelcast 5.3.7</a>] - Upgrade to Hazelcast 5.3.7</li>
+    <li>[<a href='https://github.com/igniterealtime/openfire-hazelcast-plugin/issues/59'>Issue #59</a>] - Upgrade to Hazelcast 5.3.7</li>
 </ul>
 
 <p><b>2.6.1</b> -- November 9, 2022</p>
diff --git a/classes/hazelcast-cache-config.xml b/classes/hazelcast-cache-config.xml
index 0a42cb6e4..d0d53491e 100644
--- a/classes/hazelcast-cache-config.xml
+++ b/classes/hazelcast-cache-config.xml
@@ -17,7 +17,7 @@
 <hazelcast xmlns="http://www.hazelcast.com/schema/config"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xsi:schemaLocation="http://www.hazelcast.com/schema/config
-           https://www.hazelcast.com/schema/config/hazelcast-config-5.3.xsd">
+           https://www.hazelcast.com/schema/config/hazelcast-config-5.5.xsd">
     <import resource="${openfireHome}/conf/hazelcast-local-config.xml"/>
     <cluster-name>openfire-cluster-by-hazelcast</cluster-name>
     <properties>
diff --git a/classes/hazelcast-local-config.template.xml b/classes/hazelcast-local-config.template.xml
index 0ee7ef57e..c5271a460 100644
--- a/classes/hazelcast-local-config.template.xml
+++ b/classes/hazelcast-local-config.template.xml
@@ -2,12 +2,7 @@
 <hazelcast xmlns="http://www.hazelcast.com/schema/config"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xsi:schemaLocation="http://www.hazelcast.com/schema/config
-           https://www.hazelcast.com/schema/config/hazelcast-config-5.3.xsd">
-    <!-- Recommend you open cp subsystem on your cluster -->
-    <cp-subsystem>
-        <cp-member-count>3</cp-member-count>
-        <group-size>3</group-size>
-    </cp-subsystem>
+           https://www.hazelcast.com/schema/config/hazelcast-config-5.5.xsd">
     <network>
         <port auto-increment="true" port-count="100">5701</port>
         <outbound-ports>
@@ -15,15 +10,16 @@
         </outbound-ports>
         <join>
             <!-- More about join type, you can get help from
-            https://github.com/hazelcast/hazelcast/blob/v5.3.7/hazelcast/src/main/resources/hazelcast-full-example.xml
+            https://github.com/hazelcast/hazelcast/blob/v5.5.0/hazelcast/src/main/resources/hazelcast-full-example.xml
             Now support multicast, tcp-ip, aws, gcp, azure, kubernetes, eureka, and your self discovery-strategies -->
             <multicast enabled="true">
                 <multicast-group>224.2.2.3</multicast-group>
                 <multicast-port>54327</multicast-port>
             </multicast>
+            <tcp-ip enabled="false"/>
         </join>
         <!-- The following enables TCP/IP based discovery of cluster members
-        See https://github.com/hazelcast/hazelcast/blob/v5.3.7/hazelcast/src/main/resources/hazelcast-full-example.xml#L490
+        See https://github.com/hazelcast/hazelcast/blob/v5.5.0/hazelcast/src/main/resources/hazelcast-full-example.xml#L492
         -->
         <!--
         <join>
diff --git a/plugin.xml b/plugin.xml
index d4ac96ac2..df0440f78 100644
--- a/plugin.xml
+++ b/plugin.xml
@@ -8,5 +8,5 @@
     <version>${project.version}</version>
     <date>2024-11-05</date>
     <minServerVersion>4.8.1</minServerVersion>
-    <minJavaVersion>1.8</minJavaVersion>
+    <minJavaVersion>17</minJavaVersion>
 </plugin>
diff --git a/pom.xml b/pom.xml
index e9d9ccbf7..db54626f3 100644
--- a/pom.xml
+++ b/pom.xml
@@ -8,11 +8,18 @@
     </parent>
     <groupId>org.igniterealtime.openfire.plugins</groupId>
     <artifactId>hazelcast</artifactId>
-    <version>3.1.1-SNAPSHOT</version>
+    <version>5.5.0.1-SNAPSHOT</version>
     <name>Hazelcast Plugin</name>
     <description>Adds clustering support</description>
 
     <developers>
+        <developer>
+            <name>Guus der Kinderen</name>
+            <email>guus.der.kinderen@gmail.com</email>
+            <timezone>+1</timezone>
+            <organization>Ignite Realtime</organization>
+            <organizationUrl>http://www.igniterealtime.org</organizationUrl>
+        </developer>
         <developer>
             <name>Tom Evans</name>
         </developer>
@@ -33,6 +40,15 @@
     <build>
         <sourceDirectory>src/java</sourceDirectory>
         <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <version>3.8.0</version>
+                <configuration>
+                    <source>17</source>
+                    <target>17</target>
+                </configuration>
+            </plugin>
             <plugin>
                 <artifactId>maven-assembly-plugin</artifactId>
             </plugin>
@@ -47,7 +63,7 @@
         <dependency>
             <groupId>com.hazelcast</groupId>
             <artifactId>hazelcast</artifactId>
-            <version>5.3.7</version>
+            <version>5.5.0</version>
         </dependency>
         <dependency>
             <groupId>junit</groupId>
diff --git a/readme.html b/readme.html
index e2c739a8c..854e7106d 100644
--- a/readme.html
+++ b/readme.html
@@ -63,7 +63,7 @@ <h2>Overview</h2>
 framework in lieu of an expensive proprietary third-party product.
 </p>
 <p>
-The current version of the plugin uses Hazelcast release 5.3.7
+The current version of the plugin uses Hazelcast release 5.5.0
 </p>
 <h3>Clustering vs. Federation</h3>
 <p>XMPP is designed to scale in ways that are similar to email. Each Openfire
@@ -130,6 +130,13 @@ <h2>Installation</h2>
 (commercial) and <a href="http://haproxy.1wt.eu/">HAProxy</a> (open source), among
 <a href="http://en.wikipedia.org/wiki/Load_balancing_%28computing%29">many more</a>.
 <p>
+Basic load balancing can be achieved through DNS. Openfire's <a href="https://download.igniterealtime.org/openfire/docs/latest/documentation/network-configuration-guide.html#dns">Network Configuration Guide</a>
+describes how DNS SRV records are used to resolve the servers that are part of your Openfire XMPP domain.
+<a href="https://datatracker.ietf.org/doc/html/rfc2782">A DNS SRV record</a> has 'priority' and 'weight' attributes
+that can easily be used to configure load balancing support. This does require client support. Most TCP-based XMPP
+client libraries provide such support, although DNS SRV support for web-based clients is typically lacking.
+</p>
+<p>
 A simple round-robin DNS configuration can help distribute XMPP connections across multiple
 Openfire servers in a cluster. While popular as a lightweight and low-cost way to provide
 basic scalability, note that this approach is not considered adequate for true load balancing
@@ -210,13 +217,13 @@ <h2>Configuration</h2>
 configuration file to be located outside the Openfire home directory.</li>
 <li><em>hazelcast.config.jmx.enabled</em> (false): Enables JMX support for
 the Hazelcast cluster if JMX has been enabled via the Openfire admin console.
-Refer to the <a href="https://docs.hazelcast.com/hazelcast/5.3/maintain-cluster/monitoring#monitoring-with-jmx">
+Refer to the <a href="https://docs.hazelcast.com/hazelcast/5.5/maintain-cluster/monitoring#monitoring-with-jmx">
 Hazelcast JMX docs</a> for additional information.</li>
 </ol>
 <em>Note:</em> The default <code>hazelcast-cache-config.xml</code> file included with the plugin will include a file
 <code>conf/hazelcast-local-config.xml</code> that will be preserved between plugin updates. It is recommended that
 local changes are kept in this file.
-<p>The Hazelcast plugin uses the <a href="https://docs.hazelcast.com/hazelcast/5.3/configuration/configuring-declaratively">
+<p>The Hazelcast plugin uses the <a href="https://docs.hazelcast.com/hazelcast/5.5/configuration/configuring-declaratively">
 XML configuration builder</a> to initialize the cluster from the XML file <code>conf/hazelcast-local-config.xml</code>.
 By default the cluster members will attempt to discover each other via UDP multicast at the
 following location:
@@ -241,13 +248,16 @@ <h2>Configuration</h2>
 &lt;/join&gt;
 ...
 </pre>
-<p>Please refer to the <a href="https://docs.hazelcast.com/hazelcast/5.3/">
+<p>Please refer to the <a href="https://docs.hazelcast.com/hazelcast/5.5/">
 Hazelcast reference manual</a> for more information.
 </p>
 <h3>A Word About Garbage Collection</h3>
 <p>Hazelcast is quite sensitive to delays that may be caused by long-running GC cycles which are typical 
-of servers using a default runtime JVM configuration. In most cases it will be preferable to activate the 
-concurrent garbage collector (CMS) or the new G1 garbage collector to minimize blocking within the JVM.
+of servers using a Serial garbage collector. In most cases it will be preferable to activate a garbage collector
+that reduces the pause time and latency introduced by garbage collectors. The concurrent garbage collector (CMS),
+G1 garbage collector and Z Garbage Collector (ZGC) are examples of collectors that minimize blocking within the JVM.
+</p>
+<p>
 When using CMS, you may be able to counter the effects of heap fragmentation by using JMX to invoke 
 System.gc() when the cluster is relatively idle (e.g. overnight). This has the effect of temporarily 
 interrupting the concurrent GC algorithm in favor of the default GC to collect and compact the heap.
@@ -267,7 +277,8 @@ <h3>A Word About Garbage Collection</h3>
                -XX:+PrintGCDetails -XX:+PrintPromotionFailure"
 </pre>
 <p>This GC configuration will also emit helpful GC diagnostic information to the console to aid further
-tuning and troubleshooting as appropriate for your deployment.
+tuning and troubleshooting as appropriate for your deployment. Please refer to the documentation of your Java runtime
+environment to learn about the available collectors and their configuration.
 </p>
 
 <h2>Configuring Cache expiry times and sizes</h2>
@@ -281,7 +292,7 @@ <h3>Core Openfire caches</h3>
     <code>cache.[cache name].maxLifetime</code> and <code>cache.[cache name].size</code> System Properties</p>
 
 <h3>Plugin defined caches</h3>
-A plugin can create it's own Cache without the requirement to edit any configuration files. For example;
+A plugin can create its own Cache without the requirement to edit any configuration files. For example;
 
 <pre>
     final String cacheName = "my-test-cache";
@@ -331,7 +342,7 @@ <h3>Group definition</h3>
 &lt;group&gt;
     &lt;name&gt;openfire&lt;/name&gt;
     &lt;password>mysecret&lt;/password&gt;
-    &lt;/group&gt;
+&lt;/group&gt;
 </pre>
 <p>
     With the offending lines in your configuration, the Hazelcast plugin will fail to start up, logging errors like these:
@@ -365,5 +376,25 @@ <h3>CP Subsystem</h3>
 &lt;/cp-subsystem&gt;
 </pre>
 
+<h2>Q&A for upgrade hazelcast.jar from 3.1.0 to 5.5.0 Release 1 (which upgrades Hazelcast from 5.3.7 to 5.5.0)</h2>
+<p>
+    When upgrading to hazelcast.jar 5.5.0 Release 1 from an earlier version, a minor upgrade of the Hazelcast library is
+    introduced (from 5.3.7 to 5.5.0). The configuration in <code>conf/hazelcast-local-config.xml</code> will require
+    modification for clustering functionality to be restored.
+</p>
+<p>
+    It is advisable to backup <code>conf/hazelcast-local-config.xml</code>, remove it, and have it generated anew, to
+    then manually apply previously applied configuration changes.
+</p>
+<p>
+    Support for the CP Subsystem has been removed from the community edition of Hazelcast. As a result, the
+    corresponding configuration (the <code>cp-subsystem</code> element) must be removed from your
+    <code>conf/hazelcast-local-config.xml</code> file. If the CP Subsystem configuration is not removed, the cluster
+    will fail to be initialized, and the following error will be added to the logs:
+</p>
+<p>
+    <code>2024.11.05 18:59:24.051 ERROR [PluginMonitorTask-2]: com.hazelcast.instance.impl.Node - Node creation failed
+        java.lang.IllegalStateException: CP subsystem is a licensed feature. Please ensure you have an Enterprise license that enables CP.</code>
+</p>
 </body>
 </html>