DATAREDIS-184 - Add support for 'SAVE/NOSAVE' to shutdown.

Created and added 'ShutdownOptions' to 'RedisServerCommands'. The full implementation is available for 'lettuce' and 'srp'.

When using 'jedis' the command is emulated using lua script via 'eval'.

For 'jredis' the method is not available and will throw 'UnsupportedOperationException'.

Original Pull Request: #47

Author: christophstrobl

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

@@ -760,6 +760,15 @@ public void shutdown() {
 		delegate.shutdown();
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisServerCommands#shutdown(org.springframework.data.redis.connection.RedisServerCommands.ShutdownOption)
+	 */
+	@Override
+	public void shutdown(ShutdownOption option) {
+		delegate.shutdown(option);
+	}
+
 	public Set<byte[]> sInter(byte[]... keys) {
 		Set<byte[]> results = delegate.sInter(keys);
 		if (isFutureConversion()) {

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

@@ -27,6 +27,10 @@
  */
 public interface RedisServerCommands {
 
+	public enum ShutdownOption {
+		SAVE, NOSAVE;
+	}
+
 	/**
 	 * Start an {@literal Append Only File} rewrite process on server.
 	 * 
@@ -116,6 +120,14 @@ public interface RedisServerCommands {
 	 */
 	void shutdown();
 
+	/**
+	 * Shutdown server.
+	 * 
+	 * @see http://redis.io/commands/shutdown
+	 * @since 1.3
+	 */
+	void shutdown(ShutdownOption option);
+
 	/**
 	 * Load configuration parameters for given {@code pattern} from server.
 	 * 

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

@@ -76,6 +76,8 @@ public class JedisConnection implements RedisConnection {
 	private static final Method SEND_COMMAND;
 	private static final Method GET_RESPONSE;
 
+	private static final String SHUTDOWN_SCRIPT = "return redis.call('SHUTDOWN','%s')";
+
 	static {
 		CLIENT_FIELD = ReflectionUtils.findField(BinaryJedis.class, "client", Client.class);
 		ReflectionUtils.makeAccessible(CLIENT_FIELD);
@@ -624,6 +626,21 @@ public void shutdown() {
 		}
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisServerCommands#shutdown(org.springframework.data.redis.connection.RedisServerCommands.ShutdownOption)
+	 */
+	@Override
+	public void shutdown(ShutdownOption option) {
+
+		if (option == null) {
+			shutdown();
+			return;
+		}
+
+		eval(String.format(SHUTDOWN_SCRIPT, option.name()).getBytes(), ReturnType.STATUS, 0);
+	}
+
 	public byte[] echo(byte[] message) {
 		try {
 			if (isPipelined()) {

src/main/java/org/springframework/data/redis/connection/jredis/JredisConnection.java

@@ -291,6 +291,15 @@ public void shutdown() {
 		throw new UnsupportedOperationException();
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisServerCommands#shutdown(org.springframework.data.redis.connection.RedisServerCommands.ShutdownOption)
+	 */
+	@Override
+	public void shutdown(ShutdownOption option) {
+		throw new UnsupportedOperationException();
+	}
+
 	public Long del(byte[]... keys) {
 		try {
 			return jredis.del(keys);

src/main/java/org/springframework/data/redis/connection/lettuce/LettuceConnection.java

@@ -662,6 +662,30 @@ public void shutdown() {
 		}
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisServerCommands#shutdown(org.springframework.data.redis.connection.RedisServerCommands.ShutdownOption)
+	 */
+	@Override
+	public void shutdown(ShutdownOption option) {
+
+		if (option == null) {
+			shutdown();
+			return;
+		}
+
+		boolean save = ShutdownOption.SAVE.equals(option);
+		try {
+			if (isPipelined()) {
+				getAsyncConnection().shutdown(save);
+				return;
+			}
+			getConnection().shutdown(save);
+		} catch (Exception ex) {
+			throw convertLettuceAccessException(ex);
+		}
+	}
+
 	public byte[] echo(byte[] message) {
 		try {
 			if (isPipelined()) {

src/main/java/org/springframework/data/redis/connection/srp/SrpConnection.java

@@ -24,6 +24,7 @@
 import java.util.Properties;
 import java.util.Queue;
 import java.util.Set;
+import java.util.concurrent.ArrayBlockingQueue;
 import java.util.concurrent.BlockingQueue;
 import java.util.concurrent.Future;
 
@@ -149,7 +150,7 @@ public List<Object> complete() {
 
 		public void addCommand(FutureResult result) {
 			futureResults.add(result);
-			if (!(result instanceof SrpTxResult)) {
+			if (!(result instanceof SrpTxResult) && result.getResultHolder() != null) {
 				Futures.addCallback(((SrpGenericResult) result).getResultHolder(), this);
 			}
 		}
@@ -208,6 +209,13 @@ public List<Object> get() {
 		}
 	}
 
+	SrpConnection(RedisClient client) {
+
+		Assert.notNull(client);
+		this.client = client;
+		this.queue = new ArrayBlockingQueue<SrpConnection>(50);
+	}
+
 	public SrpConnection(String host, int port, BlockingQueue<SrpConnection> queue) {
 		try {
 			this.client = new RedisClient(host, port);
@@ -481,6 +489,31 @@ public void shutdown() {
 		}
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisServerCommands#shutdown(org.springframework.data.redis.connection.RedisServerCommands.ShutdownOption)
+	 */
+	@Override
+	public void shutdown(ShutdownOption option) {
+
+		if (option == null) {
+			shutdown();
+			return;
+		}
+
+		byte[] save = option.name().getBytes(Charsets.UTF_8);
+		try {
+			if (isPipelined()) {
+				pipeline(new SrpStatusResult(pipeline.shutdown(save, null)));
+				return;
+			}
+			client.shutdown(save, null);
+		} catch (Exception ex) {
+			throw convertSrpAccessException(ex);
+		}
+
+	}
+
 	public byte[] echo(byte[] message) {
 		try {
 			if (isPipelined()) {

src/test/java/org/springframework/data/redis/connection/AbstractConnectionUnitTestBase.java

@@ -0,0 +1,69 @@
+/*
+ * Copyright 2014 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.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.redis.connection;
+
+import java.lang.reflect.ParameterizedType;
+import java.lang.reflect.Type;
+
+import org.mockito.Mockito;
+
+/**
+ * @author Christoph Strobl
+ */
+public abstract class AbstractConnectionUnitTestBase<T> {
+
+	private T nativeRedisConnectionMock;
+
+	protected T getNativeRedisConnectionMock() {
+
+		if (this.nativeRedisConnectionMock == null) {
+			Class<T> type = resolveReturnedClassFromGernericType();
+			this.nativeRedisConnectionMock = Mockito.mock(type);
+		}
+
+		return this.nativeRedisConnectionMock;
+	}
+
+	protected T verifyNativeConnectionInvocation() {
+		return Mockito.verify(getNativeRedisConnectionMock(), Mockito.times(1));
+	}
+
+	protected void setNativeRedisConnectionMock(T nativeRedisConnectionMock) {
+		this.nativeRedisConnectionMock = nativeRedisConnectionMock;
+	}
+
+	@SuppressWarnings("unchecked")
+	private Class<T> resolveReturnedClassFromGernericType() {
+
+		ParameterizedType parameterizedType = resolveReturnedClassFromGernericType(getClass());
+		return (Class<T>) parameterizedType.getActualTypeArguments()[0];
+	}
+
+	private ParameterizedType resolveReturnedClassFromGernericType(Class<?> clazz) {
+
+		Object genericSuperclass = clazz.getGenericSuperclass();
+		if (genericSuperclass instanceof ParameterizedType) {
+			ParameterizedType parameterizedType = (ParameterizedType) genericSuperclass;
+			Type rawtype = parameterizedType.getRawType();
+			if (AbstractConnectionUnitTestBase.class.equals(rawtype)) {
+				return parameterizedType;
+			}
+		}
+
+		return resolveReturnedClassFromGernericType(clazz.getSuperclass());
+	}
+
+}

src/test/java/org/springframework/data/redis/connection/DefaultStringRedisConnectionTests.java

@@ -35,6 +35,7 @@
 import org.mockito.Mock;
 import org.mockito.MockitoAnnotations;
 import org.springframework.data.redis.connection.RedisListCommands.Position;
+import org.springframework.data.redis.connection.RedisServerCommands.ShutdownOption;
 import org.springframework.data.redis.connection.RedisStringCommands.BitOperation;
 import org.springframework.data.redis.connection.RedisZSetCommands.Aggregate;
 import org.springframework.data.redis.connection.RedisZSetCommands.Tuple;
@@ -1699,6 +1700,16 @@ public void testTimeIsDelegatedCorrectlyToNativeConnection() {
 		verifyResults(Arrays.asList(1L));
 	}
 
+	/**
+	 * @see DATAREDIS-184
+	 */
+	@Test
+	public void testShutdownInDelegatedCorrectlyToNativeConnection() {
+
+		connection.shutdown(ShutdownOption.NOSAVE);
+		verify(nativeConnection, times(1)).shutdown(eq(ShutdownOption.NOSAVE));
+	}
+
 	protected List<Object> getResults() {
 		return actual;
 	}