Add support for GETEX and GETDEL through getAndExpire(…), getAndPersist(…) and getAndDelete(…) methods

pom.xml

@@ -1,11 +1,13 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
 
 	<modelVersion>4.0.0</modelVersion>
 
 	<groupId>org.springframework.data</groupId>
 	<artifactId>spring-data-redis</artifactId>
-	<version>2.6.0-SNAPSHOT</version>
+	<version>2.6.0-2050-SNAPSHOT</version>
 
 	<name>Spring Data Redis</name>
 

src/main/asciidoc/new-features.adoc

@@ -7,7 +7,7 @@ This section briefly covers items that are new and noteworthy in the latest rele
 == New in Spring Data Redis 2.6
 
 * Support for `SubscriptionListener` when using `MessageListener` for subscription confirmation callbacks. `ReactiveRedisMessageListenerContainer` and `ReactiveRedisOperations` provide `receiveLater(…)` and `listenToLater(…)` methods to await until Redis acknowledges the subscription.
-* Support Redis 6.2 commands (`LPOP`/`RPOP` with `count`, `COPY`).
+* Support Redis 6.2 commands (`LPOP`/`RPOP` with `count`, `COPY`, `GETEX`, `GETDEL`).
 
 [[new-in-2.5.0]]
 == New in Spring Data Redis 2.5

src/main/java/org/springframework/data/redis/connection/DefaultStringRedisConnection.java

@@ -410,6 +410,46 @@ public byte[] get(byte[] key) {
 		return convertAndReturn(delegate.get(key), Converters.identityConverter());
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisStringCommands#getDel(byte[])
+	 */
+	@Nullable
+	@Override
+	public byte[] getDel(byte[] key) {
+		return convertAndReturn(delegate.getDel(key), Converters.identityConverter());
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisStringCommands#getDel(byte[])
+	 */
+	@Nullable
+	@Override
+	public String getDel(String key) {
+		return convertAndReturn(delegate.getDel(serialize(key)), bytesToString);
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisStringCommands#get(byte[], org.springframework.data.redis.core.types.Expiration)
+	 */
+	@Nullable
+	@Override
+	public byte[] getEx(byte[] key, Expiration expiration) {
+		return convertAndReturn(delegate.getEx(key, expiration), Converters.identityConverter());
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisStringCommands#get(byte[], org.springframework.data.redis.core.types.Expiration)
+	 */
+	@Nullable
+	@Override
+	public String getEx(String key, Expiration expiration) {
+		return convertAndReturn(delegate.getEx(serialize(key), expiration), bytesToString);
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.redis.connection.RedisStringCommands#getBit(byte[], long)

src/main/java/org/springframework/data/redis/connection/DefaultedRedisConnection.java

@@ -276,6 +276,20 @@ default byte[] get(byte[] key) {
 		return stringCommands().get(key);
 	}
 
+	/** @deprecated in favor of {@link RedisConnection#stringCommands()}}. */
+	@Override
+	@Deprecated
+	default byte[] getEx(byte[] key, Expiration expiration) {
+		return stringCommands().getEx(key, expiration);
+	}
+
+	/** @deprecated in favor of {@link RedisConnection#stringCommands()}}. */
+	@Override
+	@Deprecated
+	default byte[] getDel(byte[] key) {
+		return stringCommands().getDel(key);
+	}
+
 	/** @deprecated in favor of {@link RedisConnection#stringCommands()}}. */
 	@Override
 	@Deprecated

src/main/java/org/springframework/data/redis/connection/ReactiveStringCommands.java

@@ -218,6 +218,109 @@ default Mono<ByteBuffer> get(ByteBuffer key) {
 	 */
 	Flux<ByteBufferResponse<KeyCommand>> get(Publisher<KeyCommand> keys);
 
+	/**
+	 * Return the value at {@code key} and delete the key.
+	 *
+	 * @param key must not be {@literal null}.
+	 * @return {@link Mono#empty()} in case {@literal key} does not exist.
+	 * @see <a href="https://redis.io/commands/getdel">Redis Documentation: GETDEL</a>
+	 * @since 2.6
+	 */
+	default Mono<ByteBuffer> getDel(ByteBuffer key) {
+
+		Assert.notNull(key, "Key must not be null!");
+
+		return getDel(Mono.just(new KeyCommand(key))).next().filter(CommandResponse::isPresent)
+				.map(CommandResponse::getOutput);
+	}
+
+	/**
+	 * Return the value at {@code key} and delete the key.
+	 *
+	 * @param commands must not be {@literal null}.
+	 * @return {@link Flux} of {@link ByteBufferResponse} holding the {@literal key} to get along with the value
+	 *         retrieved.
+	 * @see <a href="https://redis.io/commands/getdel">Redis Documentation: GETDEL</a>
+	 * @since 2.6
+	 */
+	Flux<ByteBufferResponse<KeyCommand>> getDel(Publisher<KeyCommand> commands);
+
+	/**
+	 * {@link Command} for {@code GETEX}.
+	 *
+	 * @author Mark Paluch
+	 * @since 2.6
+	 */
+	class GetExCommand extends KeyCommand {
+
+		private final Expiration expiration;
+
+		private GetExCommand(@Nullable ByteBuffer key, Expiration expiration) {
+
+			super(key);
+
+			Assert.notNull(expiration, "Expiration must not be null!");
+			this.expiration = expiration;
+		}
+
+		/**
+		 * Creates a new {@link GetExCommand} given a {@code key}.
+		 *
+		 * @param key must not be {@literal null}.
+		 * @return a new {@link GetExCommand} for {@code key}.
+		 */
+		public static GetExCommand key(ByteBuffer key) {
+			return new GetExCommand(key, Expiration.persistent());
+		}
+
+		/**
+		 * Applies {@link Expiration}. Constructs a new command instance with all previously configured properties.
+		 *
+		 * @param options must not be {@literal null}.
+		 * @return a new {@link GetExCommand} with {@link Expiration} applied.
+		 */
+		public GetExCommand withExpiration(Expiration expiration) {
+			return new GetExCommand(getKey(), expiration);
+		}
+
+		/**
+		 * Get the {@link Expiration} to apply.
+		 *
+		 * @return never {@literal null}.
+		 */
+		public Expiration getExpiration() {
+			return expiration;
+		}
+	}
+
+	/**
+	 * Return the value at {@code key} and expire the key by applying {@link Expiration}.
+	 *
+	 * @param key must not be {@literal null}.
+	 * @param expiration must not be {@literal null}.
+	 * @return {@link Mono#empty()} in case {@literal key} does not exist.
+	 * @see <a href="https://redis.io/commands/getex">Redis Documentation: GETEX</a>
+	 * @since 2.6
+	 */
+	default Mono<ByteBuffer> getEx(ByteBuffer key, Expiration expiration) {
+
+		Assert.notNull(key, "Key must not be null!");
+
+		return getEx(Mono.just(GetExCommand.key(key).withExpiration(expiration))).next().filter(CommandResponse::isPresent)
+				.map(CommandResponse::getOutput);
+	}
+
+	/**
+	 * Return the value at {@code key} and expire the key by applying {@link Expiration}.
+	 *
+	 * @param commands must not be {@literal null}.
+	 * @return {@link Flux} of {@link ByteBufferResponse} holding the {@literal key} to get along with the value
+	 *         retrieved.
+	 * @see <a href="https://redis.io/commands/getex">Redis Documentation: GETEX</a>
+	 * @since 2.6
+	 */
+	Flux<ByteBufferResponse<GetExCommand>> getEx(Publisher<GetExCommand> commands);
+
 	/**
 	 * Set {@literal value} for {@literal key} and return the existing value.
 	 *

src/main/java/org/springframework/data/redis/connection/RedisStringCommands.java

@@ -17,6 +17,7 @@
 
 import java.util.List;
 import java.util.Map;
+import java.util.concurrent.TimeUnit;
 
 import org.springframework.data.domain.Range;
 import org.springframework.data.redis.core.types.Expiration;
@@ -45,6 +46,33 @@ enum BitOperation {
 	@Nullable
 	byte[] get(byte[] key);
 
+	/**
+	 * Return the value at {@code key} and delete the key.
+	 *
+	 * @param key must not be {@literal null}.
+	 * @return {@literal null} when key does not exist or used in pipeline / transaction.
+	 * @see <a href="https://redis.io/commands/getdel">Redis Documentation: GETDEL</a>
+	 * @since 2.6
+	 */
+	@Nullable
+	byte[] getDel(byte[] key);
+
+	/**
+	 * Return the value at {@code key} and expire the key by applying {@link Expiration}.
+	 * <p />
+	 * Use {@link Expiration#seconds(long)} for {@code EX}. <br />
+	 * Use {@link Expiration#milliseconds(long)} for {@code PX}. <br />
+	 * Use {@link Expiration#unixTimestamp(long, TimeUnit)} for {@code EXAT | PXAT}. <br />
+	 *
+	 * @param key must not be {@literal null}.
+	 * @param expiration must not be {@literal null}.
+	 * @return {@literal null} when key does not exist or used in pipeline / transaction.
+	 * @see <a href="https://redis.io/commands/getex">Redis Documentation: GETEX</a>
+	 * @since 2.6
+	 */
+	@Nullable
+	byte[] getEx(byte[] key, Expiration expiration);
+
 	/**
 	 * Set {@code value} of {@code key} and return its old value.
 	 *
@@ -403,4 +431,5 @@ public static SetOption ifAbsent() {
 			return SET_IF_ABSENT;
 		}
 	}
+
 }

src/main/java/org/springframework/data/redis/connection/StringRedisConnection.java

@@ -397,6 +397,29 @@ interface StringTuple extends Tuple {
 	 */
 	String get(String key);
 
+	/**
+	 * Return the value at {@code key} and delete the key.
+	 *
+	 * @param key must not be {@literal null}.
+	 * @return {@literal null} when key does not exist or used in pipeline / transaction.
+	 * @see <a href="https://redis.io/commands/getdel">Redis Documentation: GETDEL</a>
+	 * @since 2.6
+	 */
+	@Nullable
+	String getDel(String key);
+
+	/**
+	 * Return the value at {@code key} and expire the key by applying {@link Expiration}.
+	 *
+	 * @param key must not be {@literal null}.
+	 * @param expiration must not be {@literal null}.
+	 * @return {@literal null} when key does not exist or used in pipeline / transaction.
+	 * @see <a href="https://redis.io/commands/getex">Redis Documentation: GETEX</a>
+	 * @since 2.6
+	 */
+	@Nullable
+	String getEx(String key, Expiration expiration);
+
 	/**
 	 * Set {@code value} of {@code key} and return its old value.
 	 *

src/main/java/org/springframework/data/redis/connection/jedis/JedisClusterStringCommands.java

@@ -35,6 +35,7 @@
 import org.springframework.data.redis.connection.lettuce.LettuceConverters;
 import org.springframework.data.redis.core.types.Expiration;
 import org.springframework.data.redis.util.ByteUtils;
+import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
 /**
@@ -68,6 +69,41 @@ public byte[] get(byte[] key) {
 		}
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisStringCommands#getDel(byte[])
+	 */
+	@Nullable
+	@Override
+	public byte[] getDel(byte[] key) {
+
+		Assert.notNull(key, "Key must not be null!");
+
+		try {
+			return connection.getCluster().getDel(key);
+		} catch (Exception ex) {
+			throw convertJedisAccessException(ex);
+		}
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisStringCommands#getEx(byte[], org.springframework.data.redis.core.types.Expiration)
+	 */
+	@Nullable
+	@Override
+	public byte[] getEx(byte[] key, Expiration expiration) {
+
+		Assert.notNull(key, "Key must not be null!");
+		Assert.notNull(expiration, "Expiration must not be null!");
+
+		try {
+			return connection.getCluster().getEx(key, JedisConverters.toGetExParams(expiration));
+		} catch (Exception ex) {
+			throw convertJedisAccessException(ex);
+		}
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.redis.connection.RedisStringCommands#getSet(byte[], byte[])

src/main/java/org/springframework/data/redis/connection/jedis/JedisConverters.java

@@ -23,6 +23,7 @@
 import redis.clients.jedis.ScanParams;
 import redis.clients.jedis.SortingParams;
 import redis.clients.jedis.params.GeoRadiusParam;
+import redis.clients.jedis.params.GetExParams;
 import redis.clients.jedis.params.SetParams;
 import redis.clients.jedis.params.ZAddParams;
 import redis.clients.jedis.util.SafeEncoder;
@@ -430,15 +431,48 @@ public static SetParams toSetCommandExPxArgument(Expiration expiration, SetParam
 			return paramsToUse.keepttl();
 		}
 
-		if (!expiration.isPersistent()) {
-			if (expiration.getTimeUnit() == TimeUnit.MILLISECONDS) {
-				return paramsToUse.px(expiration.getExpirationTime());
-			}
+		if (expiration.isPersistent()) {
+			return paramsToUse;
+		}
+
+		if (expiration.getTimeUnit() == TimeUnit.MILLISECONDS) {
+			return expiration.isUnixTimestamp() ? paramsToUse.pxAt(expiration.getExpirationTime()) : paramsToUse.px(expiration.getExpirationTime());
+		}
+
+		return expiration.isUnixTimestamp() ? paramsToUse.exAt(expiration.getConverted(TimeUnit.SECONDS)) : paramsToUse.ex(expiration.getConverted(TimeUnit.SECONDS));
+	}
+
+	/**
+	 * Converts a given {@link Expiration} to the according {@code GETEX} command argument depending on
+	 * {@link Expiration#isUnixTimestamp()}.
+	 * <dl>
+	 * <dt>{@link TimeUnit#MILLISECONDS}</dt>
+	 * <dd>{@code PX|PXAT}</dd>
+	 * <dt>{@link TimeUnit#SECONDS}</dt>
+	 * <dd>{@code EX|EXAT}</dd>
+	 * </dl>
+	 *
+	 * @param expiration must not be {@literal null}.
+	 * @return
+	 * @since 2.6
+	 */
+	static GetExParams toGetExParams(Expiration expiration) {
+
+		GetExParams params = new GetExParams();
 
-			return paramsToUse.ex((int) expiration.getExpirationTime());
+		if (expiration.isPersistent()) {
+			return params.persist();
+		}
+
+		if (expiration.getTimeUnit() == TimeUnit.MILLISECONDS) {
+			if (expiration.isUnixTimestamp()) {
+				return params.pxAt(expiration.getExpirationTime());
+			}
+			return params.px(expiration.getExpirationTime());
 		}
 
-		return params;
+		return expiration.isUnixTimestamp() ? params.exAt(expiration.getConverted(TimeUnit.SECONDS))
+				: params.ex(expiration.getConverted(TimeUnit.SECONDS));
 	}
 
 	/**