GH-9441: Deprecate Hazelcast CP Subsystem usage

Fixes: #9441

* Upgrade to Hazelcast `5.5`
* Deprecate `LeaderInitiator`, `HazelcastLockRegistry` since they cannot be used in Open Source due to Hazelcast CP Subsystem migration under commercial support
* Deprecate `HazelcastMembershipListener` and `HazelcastLocalInstanceRegistrar` in favor of Hazelcast `Cluster` API.
* Mention changes in the docs

Author: artembilan

Diff for: build.gradle

@@ -73,7 +73,7 @@ ext {
     greenmailVersion = '2.1.3'
     groovyVersion = '4.0.26'
     hamcrestVersion = '3.0'
-    hazelcastVersion = '5.4.0'
+    hazelcastVersion = '5.5.0'
     hibernateVersion = '6.6.13.Final'
     hsqldbVersion = '2.7.4'
     h2Version = '2.3.232'

Diff for: spring-integration-hazelcast/src/main/java/org/springframework/integration/hazelcast/HazelcastLocalInstanceRegistrar.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2015-2022 the original author or authors.
+ * Copyright 2015-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -27,7 +27,6 @@
 import org.apache.commons.logging.LogFactory;
 
 import org.springframework.beans.factory.SmartInitializingSingleton;
-import org.springframework.integration.hazelcast.listener.HazelcastMembershipListener;
 
 /**
  * This class creates an internal configuration {@link MultiMap} to cache Hazelcast instances' socket
@@ -39,7 +38,10 @@
  * @author Artem Bilan
  *
  * @since 6.0
+ *
+ * @deprecated in favor of {@link com.hazelcast.cluster.Cluster} API.
  */
+@Deprecated(forRemoval = true, since = "6.5")
 public class HazelcastLocalInstanceRegistrar implements SmartInitializingSingleton {
 
 	private static final Log logger = LogFactory.getLog(HazelcastLocalInstanceRegistrar.class);
@@ -77,12 +79,15 @@ public HazelcastLocalInstanceRegistrar(HazelcastInstance hazelcastInstance) {
 		this.hazelcastInstance = hazelcastInstance;
 	}
 
+	@SuppressWarnings("removal")
 	@Override
 	public void afterSingletonsInstantiated() {
 		if (this.hazelcastInstance == null) {
 			if (!Hazelcast.getAllHazelcastInstances().isEmpty()) {
 				HazelcastInstance anyHazelcastInstance = Hazelcast.getAllHazelcastInstances().iterator().next();
-				anyHazelcastInstance.getCluster().addMembershipListener(new HazelcastMembershipListener());
+				anyHazelcastInstance.getCluster()
+						.addMembershipListener(
+								new org.springframework.integration.hazelcast.listener.HazelcastMembershipListener());
 				syncConfigurationMultiMap(anyHazelcastInstance);
 			}
 			else {
@@ -91,7 +96,9 @@ public void afterSingletonsInstantiated() {
 		}
 		else {
 			syncConfigurationMultiMap(this.hazelcastInstance);
-			this.hazelcastInstance.getCluster().addMembershipListener(new HazelcastMembershipListener());
+			this.hazelcastInstance.getCluster()
+					.addMembershipListener(
+							new org.springframework.integration.hazelcast.listener.HazelcastMembershipListener());
 		}
 	}
 

Diff for: spring-integration-hazelcast/src/main/java/org/springframework/integration/hazelcast/config/HazelcastIntegrationConfigurationInitializer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2015-2024 the original author or authors.
+ * Copyright 2015-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,10 +17,8 @@
 package org.springframework.integration.hazelcast.inbound;
 
 import java.net.InetSocketAddress;
-import java.net.SocketAddress;
 import java.util.Collections;
 import java.util.HashMap;
-import java.util.HashSet;
 import java.util.Map;
 import java.util.Set;
 import java.util.UUID;
@@ -33,14 +31,12 @@
 import com.hazelcast.instance.EndpointQualifier;
 import com.hazelcast.map.AbstractIMapEvent;
 import com.hazelcast.map.MapEvent;
-import com.hazelcast.multimap.MultiMap;
 
 import org.springframework.integration.endpoint.MessageProducerSupport;
 import org.springframework.integration.hazelcast.CacheEventType;
 import org.springframework.integration.hazelcast.CacheListeningPolicyType;
 import org.springframework.integration.hazelcast.HazelcastHeaders;
 import org.springframework.integration.hazelcast.HazelcastIntegrationDefinitionValidator;
-import org.springframework.integration.hazelcast.HazelcastLocalInstanceRegistrar;
 import org.springframework.integration.hazelcast.message.EntryEventMessagePayload;
 import org.springframework.messaging.Message;
 import org.springframework.util.Assert;
@@ -112,40 +108,20 @@ protected abstract class AbstractHazelcastEventListener<E> {
 
 		protected void sendMessage(E event, InetSocketAddress socketAddress,
 				CacheListeningPolicyType cacheListeningPolicyType) {
-			if (CacheListeningPolicyType.ALL == cacheListeningPolicyType || isEventAcceptable(socketAddress)) {
+			if (CacheListeningPolicyType.ALL == cacheListeningPolicyType || isEventLocal(socketAddress)) {
 				AbstractHazelcastMessageProducer.this.sendMessage(toMessage(event));
 			}
 		}
 
-		private boolean isEventAcceptable(final InetSocketAddress socketAddress) {
-			final Set<HazelcastInstance> hazelcastInstanceSet = Hazelcast.getAllHazelcastInstances();
-			final Set<SocketAddress> localSocketAddressesSet = getLocalSocketAddresses(hazelcastInstanceSet);
-			return localSocketAddressesSet.isEmpty() ||
-					localSocketAddressesSet.contains(socketAddress)
-					|| isEventComingFromNonRegisteredHazelcastInstance(hazelcastInstanceSet.iterator().next(),
-					localSocketAddressesSet, socketAddress);
-
-		}
-
-		private Set<SocketAddress> getLocalSocketAddresses(final Set<HazelcastInstance> hazelcastInstanceSet) {
-			final Set<SocketAddress> localSocketAddressesSet = new HashSet<>();
+		private boolean isEventLocal(InetSocketAddress socketAddress) {
+			Set<HazelcastInstance> hazelcastInstanceSet = Hazelcast.getAllHazelcastInstances();
 			for (HazelcastInstance hazelcastInstance : hazelcastInstanceSet) {
-				localSocketAddressesSet.add(hazelcastInstance.getLocalEndpoint().getSocketAddress());
+				if (socketAddress.equals(hazelcastInstance.getLocalEndpoint().getSocketAddress())) {
+					return true;
+				}
 			}
 
-			return localSocketAddressesSet;
-		}
-
-		private boolean isEventComingFromNonRegisteredHazelcastInstance(
-				final HazelcastInstance hazelcastInstance,
-				final Set<SocketAddress> localSocketAddressesSet,
-				final InetSocketAddress socketAddressOfEvent) {
-			final MultiMap<SocketAddress, SocketAddress> configMultiMap = hazelcastInstance
-					.getMultiMap(HazelcastLocalInstanceRegistrar.SPRING_INTEGRATION_INTERNAL_CLUSTER_MULTIMAP);
-			return configMultiMap.size() > 0
-					&& !configMultiMap.values().contains(socketAddressOfEvent)
-					&& localSocketAddressesSet.contains(configMultiMap.keySet().iterator().next());
-
+			return false;
 		}
 
 	}

Diff for: spring-integration-hazelcast/src/main/java/org/springframework/integration/hazelcast/config/package-info.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2015-2024 the original author or authors.
+ * Copyright 2015-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -57,7 +57,11 @@
  * @author Robert Höglund
  * @author Christian Tzolov
  * @author Emil Palm
+ *
+ * @deprecated with no replacement since this class relies on the CP Subsystem
+ * which is not Open Source anymore since Hazelcast 5.5.
  */
+@Deprecated(forRemoval = true, since = "6.5")
 public class LeaderInitiator implements SmartLifecycle, DisposableBean, ApplicationEventPublisherAware {
 
 	private static final LogAccessor logger = new LogAccessor(LeaderInitiator.class);

Diff for: spring-integration-hazelcast/src/main/java/org/springframework/integration/hazelcast/inbound/AbstractHazelcastMessageProducer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2015-2022 the original author or authors.
+ * Copyright 2015-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -36,7 +36,11 @@
  * @author Artem Bilan
  *
  * @since 6.0
+ *
+ * @deprecated in favor of {@link com.hazelcast.cluster.Cluster} API.
  */
+@Deprecated(forRemoval = true, since = "6.5")
+@SuppressWarnings("removal")
 public class HazelcastMembershipListener extends MembershipAdapter {
 
 	@Override

Diff for: spring-integration-hazelcast/src/main/java/org/springframework/integration/hazelcast/leader/LeaderInitiator.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2022 the original author or authors.
+ * Copyright 2017-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -27,7 +27,11 @@
  * A {@link LockRegistry} implementation Hazelcast distributed locks.
  *
  * @author Artem Bilan
+ *
+ * @deprecated with no replacement since this class relies on the CP Subsystem
+ * which is not Open Source anymore since Hazelcast 5.5.
  */
+@Deprecated(forRemoval = true, since = "6.5")
 public class HazelcastLockRegistry implements LockRegistry {
 
 	private final HazelcastInstance client;

Diff for: spring-integration-hazelcast/src/main/java/org/springframework/integration/hazelcast/listener/HazelcastMembershipListener.java

@@ -3,16 +3,6 @@
 	   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 	   xsi:schemaLocation="http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd">
 
-	<bean id="instance" class="com.hazelcast.core.Hazelcast" factory-method="newHazelcastInstance" destroy-method="shutdown">
-		<constructor-arg>
-			<bean class="com.hazelcast.config.Config">
-				<property name="CPSubsystemConfig">
-					<bean class="com.hazelcast.config.cp.CPSubsystemConfig">
-						<property name="CPMemberCount" value="0"/>
-					</bean>
-				</property>
-			</bean>
-		</constructor-arg>
-	</bean>
+	<bean id="instance" class="com.hazelcast.core.Hazelcast" factory-method="newHazelcastInstance" destroy-method="shutdown"/>
 
 </beans>

Diff for: spring-integration-hazelcast/src/main/java/org/springframework/integration/hazelcast/lock/HazelcastLockRegistry.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2015-2022 the original author or authors.
+ * Copyright 2015-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -35,7 +35,6 @@
 import org.springframework.integration.config.EnableIntegration;
 import org.springframework.integration.hazelcast.DistributedSQLIterationType;
 import org.springframework.integration.hazelcast.HazelcastIntegrationTestUser;
-import org.springframework.integration.hazelcast.HazelcastLocalInstanceRegistrar;
 import org.springframework.integration.hazelcast.inbound.HazelcastClusterMonitorMessageProducer;
 import org.springframework.integration.hazelcast.inbound.HazelcastContinuousQueryMessageProducer;
 import org.springframework.integration.hazelcast.inbound.HazelcastDistributedSQLMessageSource;
@@ -225,11 +224,6 @@ public HazelcastInstance testHazelcastInstance() {
 		return Hazelcast.newHazelcastInstance(hazelcastConfig());
 	}
 
-	@Bean(HazelcastLocalInstanceRegistrar.BEAN_NAME)
-	public HazelcastLocalInstanceRegistrar hazelcastLocalInstanceRegistrar() {
-		return new HazelcastLocalInstanceRegistrar(testHazelcastInstance());
-	}
-
 	@Bean
 	public HazelcastEventDrivenMessageProducer hazelcastEventDrivenMessageProducer() {
 		final HazelcastEventDrivenMessageProducer producer =