GH-3444: Add Custom TTL support for RedisLock, and JdbcLock

Fixes: #3444

* Modify DistributedLock` interfaces.
* Modify implementation of `JdbcLockRegistry`, `RedisLockRegistry`.
* Modify JavaDoc.

Signed-off-by: Eddie Cho <[email protected]>

Author: EddieChoCho

spring-integration-core/src/main/java/org/springframework/integration/support/locks/DistributedLock.java

@@ -17,7 +17,6 @@
 package org.springframework.integration.support.locks;
 
 import java.time.Duration;
-import java.util.concurrent.TimeUnit;
 import java.util.concurrent.locks.Lock;
 
 /**
@@ -36,17 +35,14 @@ public interface DistributedLock extends Lock {
 	void lock(Duration ttl);
 
 	/**
-	 * Acquires the lock with a specific time-to-live if it is free within the
-	 * given waiting time and the current thread has not been {@linkplain Thread#interrupt interrupted}.
-	 * @param time the maximum time to wait for the lock
-	 * @param unit the time unit of the {@code time} argument
+	 * Attempt to acquire a lock with a specific time-to-live
+	 * @param waitTime the maximum time to wait for the lock
 	 * @param ttl the specific time-to-live for the lock status data
 	 * @return {@code true} if the lock was acquired and {@code false}
 	 *         if the waiting time elapsed before the lock was acquired
-	 *
 	 * @throws InterruptedException if the current thread is interrupted
 	 *         while acquiring the lock (and interruption of lock
 	 *         acquisition is supported)
 	 */
-	boolean tryLock(long time, TimeUnit unit, Duration ttl) throws InterruptedException;
+	boolean tryLock(Duration waitTime, Duration ttl) throws InterruptedException;
 }

spring-integration-core/src/main/java/org/springframework/integration/support/locks/RenewableLockRegistry.java

@@ -29,6 +29,7 @@
  * @author Alexandre Strubel
  * @author Artem Bilan
  * @author Youbin Wu
+ * @author Eddie Cho
  *
  * @since 5.4
  */
@@ -46,7 +47,7 @@ public interface RenewableLockRegistry<L extends Lock> extends LockRegistry<L> {
 	 * The lock must be held by the current thread
 	 * @param lockKey The object with which the lock is associated.
 	 * @param ttl the specific time-to-live for the lock status data
-	 *
+	 * @since 7.0
 	 */
 	void renewLock(Object lockKey, Duration ttl);
 

spring-integration-jdbc/src/main/java/org/springframework/integration/jdbc/lock/JdbcLockRegistry.java

@@ -88,6 +88,7 @@ protected boolean removeEldestEntry(Entry<String, JdbcLock> eldest) {
 
 	/**
 	 * Default value for the time-to-live property.
+	 * @since 7.0
 	 */
 	public static final Duration DEFAULT_TTL = Duration.ofSeconds(10);
 
@@ -102,6 +103,12 @@ public JdbcLockRegistry(LockRepository client) {
 		this.ttl = DEFAULT_TTL;
 	}
 
+	/**
+	 * Create a lock registry with the supplied lock expiration.
+	 * @param client the {@link LockRepository} to rely on.
+	 * @param expireAfter The expiration in {@link Duration}.
+	 * @since 7.0
+	 */
 	public JdbcLockRegistry(LockRepository client, Duration expireAfter) {
 		this.client = client;
 		this.ttl = expireAfter;
@@ -290,16 +297,16 @@ public boolean tryLock() {
 
 		@Override
 		public boolean tryLock(long time, TimeUnit unit) throws InterruptedException {
-			return tryLock(time, unit, JdbcLockRegistry.this.ttl);
+			return tryLock(Duration.of(time, unit.toChronoUnit()), JdbcLockRegistry.this.ttl);
 		}
 
 		@Override
-		public boolean tryLock(long time, TimeUnit unit, Duration ttl) throws InterruptedException {
+		public boolean tryLock(Duration waitTime, Duration ttl) throws InterruptedException {
 			long now = System.currentTimeMillis();
-			if (!this.delegate.tryLock(time, unit)) {
+			if (!this.delegate.tryLock(waitTime.toMillis(), TimeUnit.MILLISECONDS)) {
 				return false;
 			}
-			long expire = now + TimeUnit.MILLISECONDS.convert(time, unit);
+			long expire = now + waitTime.toMillis();
 			boolean acquired;
 			while (true) {
 				try {
@@ -388,6 +395,7 @@ public boolean renew() {
 		 * @param ttl the new time-to-live value for the lock status data
 		 * @return {@code true} if the lock's time-to-live was successfully renewed;
 		 *         {@code false} if the time-to-live could not be renewed
+		 * @since 7.0
 		 */
 		public boolean renew(Duration ttl) {
 			if (!this.delegate.isHeldByCurrentThread()) {

spring-integration-jdbc/src/test/java/org/springframework/integration/jdbc/lock/JdbcLockRegistryTests.java

@@ -146,7 +146,7 @@ void testTryLockWithCustomTtl() throws Exception {
 		long sleepTimeLongerThanDefaultTTL = 110;
 		for (int i = 0; i < 10; i++) {
 			DistributedLock lock = lockRegistry.obtain("foo");
-			lock.tryLock(100, TimeUnit.MILLISECONDS, Duration.ofMillis(200));
+			lock.tryLock(Duration.ofMillis(100), Duration.ofMillis(200));
 			try {
 				assertThat(TestUtils.getPropertyValue(lockRegistry, "locks", Map.class)).hasSize(1);
 				Thread.sleep(sleepTimeLongerThanDefaultTTL);
@@ -388,7 +388,7 @@ void testLockRenewWithCustomTtl() throws InterruptedException {
 		final DistributedLock lock = this.registry.obtain("foo");
 		final Lock lockOfAnotherProcess = registryOfAnotherProcess.obtain("foo");
 
-		assertThat(lock.tryLock(100, TimeUnit.MILLISECONDS, Duration.ofMillis(100))).isTrue();
+		assertThat(lock.tryLock(Duration.ofMillis(100), Duration.ofMillis(100))).isTrue();
 		try {
 			registry.renewLock("foo", Duration.ofSeconds(2));
 			Thread.sleep(110);

spring-integration-redis/src/main/java/org/springframework/integration/redis/util/RedisLockRegistry.java

@@ -170,7 +170,7 @@ protected boolean removeEldestEntry(Entry<String, RedisLock> eldest) {
 	private volatile RedisMessageListenerContainer redisMessageListenerContainer;
 
 	/**
-	 * Constructs a lock registry with the default (60 second) lock expiration.
+	 * Create a lock registry with the default (60 second) lock expiration.
 	 * @param connectionFactory The connection factory.
 	 * @param registryKey The key prefix for locks.
 	 */
@@ -179,7 +179,7 @@ public RedisLockRegistry(RedisConnectionFactory connectionFactory, String regist
 	}
 
 	/**
-	 * Constructs a lock registry with the supplied lock expiration.
+	 * Create a lock registry with the supplied lock expiration.
 	 * @param connectionFactory The connection factory.
 	 * @param registryKey The key prefix for locks.
 	 * @param expireAfter The expiration in milliseconds.
@@ -189,10 +189,11 @@ public RedisLockRegistry(RedisConnectionFactory connectionFactory, String regist
 	}
 
 	/**
-	 * Constructs a lock registry with the supplied lock expiration.
+	 * Create a lock registry with the supplied lock expiration.
 	 * @param connectionFactory The connection factory.
 	 * @param registryKey The key prefix for locks.
 	 * @param expireAfter The expiration in {@link Duration}.
+	 * @since 7.0
 	 */
 	public RedisLockRegistry(RedisConnectionFactory connectionFactory, String registryKey, Duration expireAfter) {
 		Assert.notNull(connectionFactory, "'connectionFactory' cannot be null");
@@ -500,17 +501,16 @@ public final boolean tryLock() {
 
 		@Override
 		public final boolean tryLock(long time, TimeUnit unit) throws InterruptedException {
-			return this.tryLock(time, unit, RedisLockRegistry.this.expireAfter);
+			return this.tryLock(Duration.of(time, unit.toChronoUnit()), RedisLockRegistry.this.expireAfter);
 		}
 
 		@Override
-		public boolean tryLock(long time, TimeUnit unit, Duration ttl) throws InterruptedException {
-			if (!this.localLock.tryLock(time, unit)) {
+		public boolean tryLock(Duration waitTime, Duration ttl) throws InterruptedException {
+			if (!this.localLock.tryLock(waitTime.toMillis(), TimeUnit.MILLISECONDS)) {
 				return false;
 			}
 			try {
-				long waitTime = TimeUnit.MILLISECONDS.convert(time, unit);
-				boolean acquired = tryRedisLock(waitTime, ttl.toMillis());
+				boolean acquired = tryRedisLock(waitTime.toMillis(), ttl.toMillis());
 				if (!acquired) {
 					this.localLock.unlock();
 				}

spring-integration-redis/src/test/java/org/springframework/integration/redis/util/RedisLockRegistryTests.java

@@ -151,7 +151,7 @@ void testTryLockWithCustomTtl(RedisLockType testRedisLockType) throws Interrupte
 		registry.setRedisLockType(testRedisLockType);
 		for (int i = 0; i < 3; i++) {
 			DistributedLock lock = registry.obtain("foo");
-			lock.tryLock(100, TimeUnit.MILLISECONDS, Duration.ofMillis(500));
+			lock.tryLock(Duration.ofMillis(100), Duration.ofMillis(500));
 			try {
 				assertThat(getRedisLockRegistryLocks(registry)).hasSize(1);
 				Thread.sleep(sleepTimeLongerThanDefaultTTL);
@@ -999,7 +999,7 @@ void testLockRenewWithCustomTtl(RedisLockType redisLockType) throws InterruptedE
 		final Lock lockOfAnotherProcess = registryOfAnotherProcess.obtain("foo");
 		long ttl = 100;
 		long sleepTimeLongerThanTtl = 110;
-		assertThat(lock.tryLock(100, TimeUnit.MILLISECONDS, Duration.ofMillis(ttl))).isTrue();
+		assertThat(lock.tryLock(Duration.ofMillis(100), Duration.ofMillis(ttl))).isTrue();
 		try {
 			registry.renewLock("foo", Duration.ofSeconds(2));
 			Thread.sleep(sleepTimeLongerThanTtl);

src/reference/antora/modules/ROOT/pages/whats-new.adoc

@@ -25,6 +25,9 @@ Junit 4 Based Support Components are deprecated.
 The JDBC module now provides a Java DSL API via its dedicated `org.springframework.integration.jdbc.dsl.Jdbc` factory.
 The xref:jdbc/dsl.adoc[] chapter provides more details.
 
+A new `DistributedLock` interface has been introduced, providing new methods, `lock(Duration ttl`) and `tryLock(long time, TimeUnit unit, Duration ttl)`, to acquire a lock with a custom time-to-live (TTL).
+See xref:distributed-locks.adoc[] for more information.
+
 [[x7.0-jdbc-changes]]
 === JDBC Changes