Rename CustomTtlLock to DistributedLock

EddieChoCho · EddieChoCho · commit b30c57c0df49 · 2024-06-26T14:48:16.000+02:00
Remove `CustomTtlLockRegistry`
diff --git a/spring-integration-core/src/main/java/org/springframework/integration/aggregator/AbstractCorrelatingMessageHandler.java b/spring-integration-core/src/main/java/org/springframework/integration/aggregator/AbstractCorrelatingMessageHandler.java
@@ -130,7 +130,7 @@ public abstract class AbstractCorrelatingMessageHandler extends AbstractMessageP
 
 	private boolean sequenceAware;
 
-	private LockRegistry lockRegistry = new DefaultLockRegistry();
+	private LockRegistry<?> lockRegistry = new DefaultLockRegistry();
 
 	private boolean lockRegistrySet = false;
 
@@ -193,7 +193,7 @@ public AbstractCorrelatingMessageHandler(MessageGroupProcessor processor) {
 		this(processor, new SimpleMessageStore(0), null, null);
 	}
 
-	public void setLockRegistry(LockRegistry lockRegistry) {
+	public void setLockRegistry(LockRegistry<?> lockRegistry) {
 		Assert.isTrue(!this.lockRegistrySet, "'this.lockRegistry' can not be reset once its been set");
 		Assert.notNull(lockRegistry, "'lockRegistry' must not be null");
 		this.lockRegistry = lockRegistry;
@@ -499,7 +499,7 @@ protected boolean isSequenceAware() {
 		return this.sequenceAware;
 	}
 
-	protected LockRegistry getLockRegistry() {
+	protected LockRegistry<?> getLockRegistry() {
 		return this.lockRegistry;
 	}
 
diff --git a/spring-integration-core/src/main/java/org/springframework/integration/config/AggregatorFactoryBean.java b/spring-integration-core/src/main/java/org/springframework/integration/config/AggregatorFactoryBean.java
@@ -65,7 +65,7 @@ public class AggregatorFactoryBean extends AbstractSimpleMessageHandlerFactoryBe
 
 	private String outputChannelName;
 
-	private LockRegistry lockRegistry;
+	private LockRegistry<?> lockRegistry;
 
 	private MessageGroupStore messageStore;
 
@@ -122,7 +122,7 @@ public void setOutputChannelName(String outputChannelName) {
 		this.outputChannelName = outputChannelName;
 	}
 
-	public void setLockRegistry(LockRegistry lockRegistry) {
+	public void setLockRegistry(LockRegistry<?> lockRegistry) {
 		this.lockRegistry = lockRegistry;
 	}
 
diff --git a/spring-integration-core/src/main/java/org/springframework/integration/dsl/CorrelationHandlerSpec.java b/spring-integration-core/src/main/java/org/springframework/integration/dsl/CorrelationHandlerSpec.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2022 the original author or authors.
+ * Copyright 2016-2024 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.
@@ -299,7 +299,7 @@ public S forceReleaseAdvice(Advice... advice) {
 	 * @param lockRegistry the {@link LockRegistry} to use.
 	 * @return the endpoint spec.
 	 */
-	public S lockRegistry(LockRegistry lockRegistry) {
+	public S lockRegistry(LockRegistry<?> lockRegistry) {
 		Assert.notNull(lockRegistry, "'lockRegistry' must not be null.");
 		this.handler.setLockRegistry(lockRegistry);
 		return _this();
diff --git a/spring-integration-core/src/main/java/org/springframework/integration/metadata/PropertiesPersistingMetadataStore.java b/spring-integration-core/src/main/java/org/springframework/integration/metadata/PropertiesPersistingMetadataStore.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2022 the original author or authors.
+ * Copyright 2002-2024 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.
@@ -65,7 +65,7 @@ public class PropertiesPersistingMetadataStore implements ConcurrentMetadataStor
 
 	private final DefaultPropertiesPersister persister = new DefaultPropertiesPersister();
 
-	private final LockRegistry lockRegistry = new DefaultLockRegistry();
+	private final LockRegistry<Lock> lockRegistry = new DefaultLockRegistry();
 
 	private String baseDirectory = System.getProperty("java.io.tmpdir") + "/spring-integration/";
 
diff --git a/spring-integration-core/src/main/java/org/springframework/integration/store/SimpleMessageStore.java b/spring-integration-core/src/main/java/org/springframework/integration/store/SimpleMessageStore.java
@@ -71,7 +71,7 @@ public class SimpleMessageStore extends AbstractMessageGroupStore
 
 	private final long upperBoundTimeout;
 
-	private LockRegistry lockRegistry;
+	private LockRegistry<?> lockRegistry;
 
 	private boolean copyOnGet = false;
 
@@ -111,7 +111,7 @@ public SimpleMessageStore(int individualCapacity, int groupCapacity, long upperB
 	 * @param lockRegistry       The lock registry.
 	 * @see #SimpleMessageStore(int, int, long, LockRegistry)
 	 */
-	public SimpleMessageStore(int individualCapacity, int groupCapacity, LockRegistry lockRegistry) {
+	public SimpleMessageStore(int individualCapacity, int groupCapacity, LockRegistry<?> lockRegistry) {
 		this(individualCapacity, groupCapacity, 0, lockRegistry);
 	}
 
@@ -126,7 +126,7 @@ public SimpleMessageStore(int individualCapacity, int groupCapacity, LockRegistr
 	 * @since 4.3
 	 */
 	public SimpleMessageStore(int individualCapacity, int groupCapacity, long upperBoundTimeout,
-			LockRegistry lockRegistry) {
+			LockRegistry<?> lockRegistry) {
 
 		super(false);
 		Assert.notNull(lockRegistry, "The LockRegistry cannot be null");
@@ -162,7 +162,7 @@ public void setCopyOnGet(boolean copyOnGet) {
 		this.copyOnGet = copyOnGet;
 	}
 
-	public void setLockRegistry(LockRegistry lockRegistry) {
+	public void setLockRegistry(LockRegistry<?> lockRegistry) {
 		Assert.notNull(lockRegistry, "The LockRegistry cannot be null");
 		Assert.isTrue(!(this.isUsed), "Cannot change the lock registry after the store has been used");
 		this.lockRegistry = lockRegistry;
diff --git a/spring-integration-core/src/main/java/org/springframework/integration/support/leader/LockRegistryLeaderInitiator.java b/spring-integration-core/src/main/java/org/springframework/integration/support/leader/LockRegistryLeaderInitiator.java
@@ -74,7 +74,7 @@ public class LockRegistryLeaderInitiator implements SmartLifecycle, DisposableBe
 	 * A lock registry. The locks it manages should be global (whatever that means for the
 	 * system) and expiring, in case the holder dies without notifying anyone.
 	 */
-	private final LockRegistry locks;
+	private final LockRegistry<?> locks;
 
 	/**
 	 * Candidate for leader election. User injects this to receive callbacks on leadership
@@ -162,7 +162,7 @@ public String getRole() {
 	 * candidate (which just logs the leadership events).
 	 * @param locks lock registry
 	 */
-	public LockRegistryLeaderInitiator(LockRegistry locks) {
+	public LockRegistryLeaderInitiator(LockRegistry<?> locks) {
 		this(locks, new DefaultCandidate());
 	}
 
@@ -172,7 +172,7 @@ public LockRegistryLeaderInitiator(LockRegistry locks) {
 	 * @param locks lock registry
 	 * @param candidate leadership election candidate
 	 */
-	public LockRegistryLeaderInitiator(LockRegistry locks, Candidate candidate) {
+	public LockRegistryLeaderInitiator(LockRegistry<?> locks, Candidate candidate) {
 		Assert.notNull(locks, "'locks' must not be null");
 		Assert.notNull(candidate, "'candidate' must not be null");
 		this.locks = locks;
diff --git a/spring-integration-core/src/main/java/org/springframework/integration/support/locks/CustomTtlLockRegistry.java b/spring-integration-core/src/main/java/org/springframework/integration/support/locks/CustomTtlLockRegistry.java
diff --git a/spring-integration-core/src/main/java/org/springframework/integration/support/locks/DefaultLockRegistry.java b/spring-integration-core/src/main/java/org/springframework/integration/support/locks/DefaultLockRegistry.java
@@ -34,7 +34,7 @@
  * @since 2.1.1
  *
  */
-public final class DefaultLockRegistry implements LockRegistry {
+public final class DefaultLockRegistry implements LockRegistry<Lock> {
 
 	private final Lock[] lockTable;
 
diff --git a/spring-integration-core/src/main/java/org/springframework/integration/support/locks/DistributedLock.java b/spring-integration-core/src/main/java/org/springframework/integration/support/locks/DistributedLock.java
@@ -20,13 +20,13 @@
 import java.util.concurrent.locks.Lock;
 
 /**
- * A {@link Lock} implementing this interface supports the spring distributed locks with custom time-to-live value per lock
+ * A {@link Lock} implementing for spring distributed locks
  *
  * @author Eddie Cho
  *
  * @since 6.3
  */
-public interface CustomTtlLock extends Lock {
+public interface DistributedLock extends Lock {
 
 	/**
 	 * Attempt to acquire a lock with a specific time-to-live
diff --git a/spring-integration-core/src/main/java/org/springframework/integration/support/locks/ExpirableLockRegistry.java b/spring-integration-core/src/main/java/org/springframework/integration/support/locks/ExpirableLockRegistry.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2015-2019 the original author or authors.
+ * Copyright 2015-2024 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.
@@ -16,15 +16,18 @@
 
 package org.springframework.integration.support.locks;
 
+import java.util.concurrent.locks.Lock;
+
 /**
  * A {@link LockRegistry} implementing this interface supports the removal of aged locks
  * that are not currently locked.
+ * @param <L> The expected class of the lock implementation
  *
  * @author Gary Russell
  * @since 4.2
  *
  */
-public interface ExpirableLockRegistry extends LockRegistry {
+public interface ExpirableLockRegistry<L extends Lock> extends LockRegistry<L> {
 
 	/**
 	 * Remove locks last acquired more than 'age' ago that are not currently locked.
diff --git a/spring-integration-core/src/main/java/org/springframework/integration/support/locks/LockRegistry.java b/spring-integration-core/src/main/java/org/springframework/integration/support/locks/LockRegistry.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2023 the original author or authors.
+ * Copyright 2002-2024 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.
@@ -26,6 +26,7 @@
 
 /**
  * Strategy for maintaining a registry of shared locks.
+ * @param <L> The expected class of the lock implementation
  *
  * @author Oleg Zhurakousky
  * @author Gary Russell
@@ -34,14 +35,14 @@
  * @since 2.1.1
  */
 @FunctionalInterface
-public interface LockRegistry {
+public interface LockRegistry<L extends Lock> {
 
 	/**
 	 * Obtain the lock associated with the parameter object.
 	 * @param lockKey The object with which the lock is associated.
 	 * @return The associated lock.
 	 */
-	Lock obtain(Object lockKey);
+	L obtain(Object lockKey);
 
 	/**
 	 * Perform the provided task when the lock for the key is locked.
diff --git a/spring-integration-core/src/main/java/org/springframework/integration/support/locks/PassThruLockRegistry.java b/spring-integration-core/src/main/java/org/springframework/integration/support/locks/PassThruLockRegistry.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2019 the original author or authors.
+ * Copyright 2002-2024 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.
@@ -33,7 +33,7 @@
  * @since 2.2
  *
  */
-public final class PassThruLockRegistry implements LockRegistry {
+public final class PassThruLockRegistry implements LockRegistry<Lock> {
 
 	@Override
 	public Lock obtain(Object lockKey) {
diff --git a/spring-integration-core/src/main/java/org/springframework/integration/support/locks/RenewableLockRegistry.java b/spring-integration-core/src/main/java/org/springframework/integration/support/locks/RenewableLockRegistry.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2020 the original author or authors.
+ * Copyright 2020-2024 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.
@@ -16,16 +16,19 @@
 
 package org.springframework.integration.support.locks;
 
+import java.util.concurrent.locks.Lock;
+
 /**
  * A {@link LockRegistry} implementing this interface supports the renewal
  * of the time to live of a lock.
+ * @param <L> The expected class of the lock implementation
  *
  * @author Alexandre Strubel
  * @author Artem Bilan
  *
  * @since 5.4
  */
-public interface RenewableLockRegistry extends LockRegistry {
+public interface RenewableLockRegistry<L extends Lock> extends LockRegistry<L> {
 
 	/**
 	 * Renew the time to live of the lock is associated with the parameter object.
diff --git a/spring-integration-core/src/test/java/org/springframework/integration/support/leader/LockRegistryLeaderInitiatorTests.java b/spring-integration-core/src/test/java/org/springframework/integration/support/leader/LockRegistryLeaderInitiatorTests.java
@@ -61,7 +61,7 @@ public class LockRegistryLeaderInitiatorTests {
 
 	private CountDownLatch revoked = new CountDownLatch(1);
 
-	private final LockRegistry registry = new DefaultLockRegistry();
+	private final LockRegistry<Lock> registry = new DefaultLockRegistry();
 
 	private final LockRegistryLeaderInitiator initiator =
 			new LockRegistryLeaderInitiator(this.registry, new DefaultCandidate());
@@ -275,7 +275,7 @@ public void testExceptionFromLock() throws Exception {
 			}
 		}).given(mockLock).tryLock(anyLong(), any(TimeUnit.class));
 
-		LockRegistry registry = lockKey -> mockLock;
+		LockRegistry<Lock> registry = lockKey -> mockLock;
 
 		CountDownLatch onGranted = new CountDownLatch(1);
 
diff --git a/spring-integration-core/src/test/java/org/springframework/integration/support/locks/DefaultLockRegistryTests.java b/spring-integration-core/src/test/java/org/springframework/integration/support/locks/DefaultLockRegistryTests.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2023 the original author or authors.
+ * Copyright 2002-2024 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.
@@ -56,7 +56,7 @@ public void testBadMaskOutOfRange() { // 32bits
 
 	@Test
 	public void testSingleLockCreation() {
-		LockRegistry registry = new DefaultLockRegistry(0);
+		LockRegistry<Lock> registry = new DefaultLockRegistry(0);
 		Lock a = registry.obtain(23);
 		Lock b = registry.obtain(new Object());
 		Lock c = registry.obtain("hello");
@@ -67,7 +67,7 @@ public void testSingleLockCreation() {
 
 	@Test
 	public void testSame() {
-		LockRegistry registry = new DefaultLockRegistry();
+		LockRegistry<Lock> registry = new DefaultLockRegistry();
 		Lock lock1 = registry.obtain(new Object() {
 
 			@Override
@@ -87,7 +87,7 @@ public int hashCode() {
 
 	@Test
 	public void testDifferent() {
-		LockRegistry registry = new DefaultLockRegistry();
+		LockRegistry<Lock> registry = new DefaultLockRegistry();
 		Lock lock1 = registry.obtain(new Object() {
 
 			@Override
@@ -107,7 +107,7 @@ public int hashCode() {
 
 	@Test
 	public void testAllDifferentAndSame() {
-		LockRegistry registry = new DefaultLockRegistry(3);
+		LockRegistry<Lock> registry = new DefaultLockRegistry(3);
 		Lock[] locks = new Lock[4];
 		locks[0] = registry.obtain(new Object() {
 
@@ -213,7 +213,7 @@ public int hashCode() {
 
 	@Test
 	public void cyclicBarrierIsBrokenWhenExecutedConcurrentlyInLock() throws Exception {
-		LockRegistry registry = new DefaultLockRegistry(1);
+		LockRegistry<Lock> registry = new DefaultLockRegistry(1);
 
 		CyclicBarrier cyclicBarrier = new CyclicBarrier(2);
 		CountDownLatch brokenBarrierLatch = new CountDownLatch(2);
@@ -245,7 +245,7 @@ public void cyclicBarrierIsBrokenWhenExecutedConcurrentlyInLock() throws Excepti
 
 	@Test
 	public void executeLockedIsTimedOutInOtherThread() throws Exception {
-		LockRegistry registry = new DefaultLockRegistry(1);
+		LockRegistry<Lock> registry = new DefaultLockRegistry(1);
 
 		String lockKey = "lockKey";
 		Duration waitLockDuration = Duration.ofMillis(100);
diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/FileWritingMessageHandler.java b/spring-integration-file/src/main/java/org/springframework/integration/file/FileWritingMessageHandler.java
@@ -161,7 +161,7 @@ public class FileWritingMessageHandler extends AbstractReplyProducingMessageHand
 
 	private boolean appendNewLine = false;
 
-	private LockRegistry lockRegistry = new PassThruLockRegistry();
+	private LockRegistry<Lock> lockRegistry = new PassThruLockRegistry();
 
 	private int bufferSize = DEFAULT_BUFFER_SIZE;
 
diff --git a/spring-integration-hazelcast/src/main/java/org/springframework/integration/hazelcast/lock/HazelcastLockRegistry.java b/spring-integration-hazelcast/src/main/java/org/springframework/integration/hazelcast/lock/HazelcastLockRegistry.java
@@ -28,7 +28,7 @@
  *
  * @author Artem Bilan
  */
-public class HazelcastLockRegistry implements LockRegistry {
+public class HazelcastLockRegistry implements LockRegistry<Lock> {
 
 	private final HazelcastInstance client;
 
diff --git a/spring-integration-jdbc/src/main/java/org/springframework/integration/jdbc/lock/JdbcLockRegistry.java b/spring-integration-jdbc/src/main/java/org/springframework/integration/jdbc/lock/JdbcLockRegistry.java
diff --git a/spring-integration-jdbc/src/test/java/org/springframework/integration/jdbc/lock/JdbcLockRegistryTests.java b/spring-integration-jdbc/src/test/java/org/springframework/integration/jdbc/lock/JdbcLockRegistryTests.java
diff --git a/spring-integration-redis/src/main/java/org/springframework/integration/redis/util/RedisLockRegistry.java b/spring-integration-redis/src/main/java/org/springframework/integration/redis/util/RedisLockRegistry.java
diff --git a/spring-integration-redis/src/test/java/org/springframework/integration/redis/util/RedisLockRegistryTests.java b/spring-integration-redis/src/test/java/org/springframework/integration/redis/util/RedisLockRegistryTests.java
diff --git a/spring-integration-zookeeper/src/main/java/org/springframework/integration/zookeeper/lock/ZookeeperLockRegistry.java b/spring-integration-zookeeper/src/main/java/org/springframework/integration/zookeeper/lock/ZookeeperLockRegistry.java

Original file line number	Diff line number	Diff line change
`@@ -130,7 +130,7 @@ public abstract class AbstractCorrelatingMessageHandler extends AbstractMessageP`
`130`	`130`
`131`	`131`	`private boolean sequenceAware;`
`132`	`132`
`133`		`- private LockRegistry lockRegistry = new DefaultLockRegistry();`
	`133`	`+ private LockRegistry<?> lockRegistry = new DefaultLockRegistry();`
`134`	`134`
`135`	`135`	`private boolean lockRegistrySet = false;`
`136`	`136`
`@@ -193,7 +193,7 @@ public AbstractCorrelatingMessageHandler(MessageGroupProcessor processor) {`
`193`	`193`	`this(processor, new SimpleMessageStore(0), null, null);`
`194`	`194`	`}`
`195`	`195`
`196`		`- public void setLockRegistry(LockRegistry lockRegistry) {`
	`196`	`+ public void setLockRegistry(LockRegistry<?> lockRegistry) {`
`197`	`197`	`Assert.isTrue(!this.lockRegistrySet, "'this.lockRegistry' can not be reset once its been set");`
`198`	`198`	`Assert.notNull(lockRegistry, "'lockRegistry' must not be null");`
`199`	`199`	`this.lockRegistry = lockRegistry;`
`@@ -499,7 +499,7 @@ protected boolean isSequenceAware() {`
`499`	`499`	`return this.sequenceAware;`
`500`	`500`	`}`
`501`	`501`
`502`		`- protected LockRegistry getLockRegistry() {`
	`502`	`+ protected LockRegistry<?> getLockRegistry() {`
`503`	`503`	`return this.lockRegistry;`
`504`	`504`	`}`
`505`	`505`
Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ public class AggregatorFactoryBean extends AbstractSimpleMessageHandlerFactoryBe`
`65`	`65`
`66`	`66`	`private String outputChannelName;`
`67`	`67`
`68`		`- private LockRegistry lockRegistry;`
	`68`	`+ private LockRegistry<?> lockRegistry;`
`69`	`69`
`70`	`70`	`private MessageGroupStore messageStore;`
`71`	`71`
`@@ -122,7 +122,7 @@ public void setOutputChannelName(String outputChannelName) {`
`122`	`122`	`this.outputChannelName = outputChannelName;`
`123`	`123`	`}`
`124`	`124`
`125`		`- public void setLockRegistry(LockRegistry lockRegistry) {`
	`125`	`+ public void setLockRegistry(LockRegistry<?> lockRegistry) {`
`126`	`126`	`this.lockRegistry = lockRegistry;`
`127`	`127`	`}`
`128`	`128`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@`
`34`	`34`	`* @since 2.1.1`
`35`	`35`	`*`
`36`	`36`	`*/`
`37`		`-public final class DefaultLockRegistry implements LockRegistry {`
	`37`	`+public final class DefaultLockRegistry implements LockRegistry<Lock> {`
`38`	`38`
`39`	`39`	`private final Lock[] lockTable;`
`40`	`40`
Original file line number	Diff line number	Diff line change
`@@ -20,13 +20,13 @@`
`20`	`20`	`import java.util.concurrent.locks.Lock;`
`21`	`21`
`22`	`22`	`/**`
`23`		`- * A {@link Lock} implementing this interface supports the spring distributed locks with custom time-to-live value per lock`
	`23`	`+ * A {@link Lock} implementing for spring distributed locks`
`24`	`24`	`*`
`25`	`25`	`* @author Eddie Cho`
`26`	`26`	`*`
`27`	`27`	`* @since 6.3`
`28`	`28`	`*/`
`29`		`-public interface CustomTtlLock extends Lock {`
	`29`	`+public interface DistributedLock extends Lock {`
`30`	`30`
`31`	`31`	`/**`
`32`	`32`	`* Attempt to acquire a lock with a specific time-to-live`