DATAREDIS-269 - Add support for 'CLIENT SETNAME'.

Setting client name is possible for 'jedis', 'lettuce' and 'srp'.
Using 'jredis' throws 'UnspupportedOperationException'.

Original Pull Request: #54

Author: christophstrobl

docs/src/reference/docbook/appendix/appendix-command-reference.xml

@@ -26,7 +26,7 @@
 				<row><entry><code>CLIENT GETNAME</code></entry><entry>-</entry></row>
 				<row><entry><code>CLIENT KILL</code></entry><entry>X</entry></row>
 				<row><entry><code>CLIENT LIST</code></entry><entry>-</entry></row>
-				<row><entry><code>CLIENT SETNAME</code></entry><entry>-</entry></row>
+				<row><entry><code>CLIENT SETNAME</code></entry><entry>X</entry></row>
 				<row><entry><code>CONFIG GET</code></entry><entry>X</entry></row>
 				<row><entry><code>CONFIG RESETSTAT</code></entry><entry>X</entry></row>
 				<row><entry><code>CONFIG REWRITE</code></entry><entry>-</entry></row>

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

@@ -2239,4 +2239,22 @@ private List<Object> convertResults(List<Object> results, Queue<Converter> conve
 		return convertedResults;
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisServerCommands#setClientName(java.lang.String)
+	 */
+	@Override
+	public void setClientName(byte[] name) {
+		this.delegate.setClientName(name);
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.StringRedisConnection#setClientName(java.lang.String)
+	 */
+	@Override
+	public void setClientName(String name) {
+		setClientName(this.serializer.serialize(name));
+	}
+
 }

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

@@ -171,4 +171,10 @@ public enum ShutdownOption {
 	 */
 	void killClient(String host, int port);
 
+	/**
+	 * Assign given name to current connection.
+	 * 
+	 * @since 1.3
+	 */
+	void setClientName(byte[] name);
 }

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

@@ -292,4 +292,13 @@ public interface StringTuple extends Tuple {
 	<T> T eval(String script, ReturnType returnType, int numKeys, String... keysAndArgs);
 
 	<T> T evalSha(String scriptSha1, ReturnType returnType, int numKeys, String... keysAndArgs);
+
+	/**
+	 * Assign given {@code name} to connection using registered {@link RedisSerializer} for name conversion.
+	 * 
+	 * @param name
+	 * @see #setClientName(byte[])
+	 * @sice 1.3
+	 */
+	void setClientName(String name);
 }

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

@@ -2828,6 +2828,19 @@ public void killClient(String host, int port) {
 		}
 	}
 
+	/*
+	* @see org.springframework.data.redis.connection.RedisServerCommands#setClientName(java.lang.String)
+	*/
+	@Override
+	public void setClientName(byte[] name) {
+
+		if (isPipelined() || isQueueing()) {
+			throw new UnsupportedOperationException("'CLIENT SETNAME' is not suppored in transacton / pipeline mode.");
+		}
+
+		jedis.clientSetname(name);
+	}
+
 	/**
 	 * Specifies if pipelined results should be converted to the expected data type. If false, results of
 	 * {@link #closePipeline()} and {@link #exec()} will be of the type returned by the Jedis driver

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

@@ -1190,4 +1190,9 @@ public Long time() {
 	public void killClient(String host, int port) {
 		throw new UnsupportedOperationException("The 'CLIENT KILL' command is not supported by the JRedis driver.");
 	}
+
+	@Override
+	public void setClientName(byte[] name) {
+		throw new UnsupportedOperationException("'CLIENT SETNAME' is not supported by the JRedis driver.");
+	}
 }

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

@@ -2920,6 +2920,21 @@ public void killClient(String host, int port) {
 		}
 	}
 
+	@Override
+	public void setClientName(byte[] name) {
+
+		if (isQueueing()) {
+			pipeline(new LettuceStatusResult(getAsyncConnection().clientSetname(name)));
+			return;
+		}
+		if (isQueueing()) {
+			transaction(new LettuceTxResult(getConnection().clientSetname(name)));
+			return;
+		}
+
+		getAsyncConnection().clientSetname(name);
+	}
+
 	/**
 	 * Specifies if pipelined and transaction results should be converted to the expected data type. If false, results of
 	 * {@link #closePipeline()} and {@link #exec()} will be of the type returned by the Lettuce driver

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

@@ -2240,6 +2240,26 @@ public void killClient(String host, int port) {
 		}
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisServerCommands#setClientName(byte[])
+	 */
+	@Override
+	public void setClientName(byte[] name) {
+
+		try {
+
+			if (isPipelined()) {
+				pipeline(new SrpStatusResult(pipeline.client_setname(name)));
+				return;
+			}
+
+			this.client.client_setname(name);
+		} catch (Exception ex) {
+			throw convertSrpAccessException(ex);
+		}
+	}
+
 	private List<Object> closeTransaction() {
 		List<Object> results = Collections.emptyList();
 		if (txTracker != null) {

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

@@ -1884,6 +1884,14 @@ public void testGetTimeShouldRequestServerTime() {
 		assertThat(time > 0, equalTo(true));
 	}
 
+	/**
+	 * @see DATAREDIS-269
+	 */
+	@Test
+	public void clientSetNameWorksCorrectly() {
+		connection.setClientName("foo".getBytes());
+	}
+
 	protected void verifyResults(List<Object> expected) {
 		assertEquals(expected, getResults());
 	}

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

@@ -1710,6 +1710,16 @@ public void testShutdownInDelegatedCorrectlyToNativeConnection() {
 		verify(nativeConnection, times(1)).shutdown(eq(ShutdownOption.NOSAVE));
 	}
 
+	/**
+	 * @see DATAREDIS-269
+	 */
+	@Test
+	public void settingClientNameShouldDelegateToNativeConnection() {
+
+		connection.setClientName("foo");
+		verify(nativeConnection, times(1)).setClientName(eq("foo".getBytes()));
+	}
+
 	protected List<Object> getResults() {
 		return actual;
 	}

src/test/java/org/springframework/data/redis/connection/jedis/JedisConnectionPipelineIntegrationTests.java

@@ -246,4 +246,12 @@ public void testInfoBySection() throws Exception {
 	public void testZAddMultiple() {
 		super.testZAddMultiple();
 	}
+
+	/**
+	 * @see DATAREDIS-269
+	 */
+	@Test(expected = UnsupportedOperationException.class)
+	public void clientSetNameWorksCorrectly() {
+		super.clientSetNameWorksCorrectly();
+	}
 }

src/test/java/org/springframework/data/redis/connection/jedis/JedisConnectionTransactionIntegrationTests.java

@@ -191,4 +191,13 @@ public void testRestoreBadData() {
 	public void testRestoreExistingKey() {
 		super.testRestoreExistingKey();
 	}
+
+	/**
+	 * @see DATAREDIS-269
+	 */
+	@Test(expected = UnsupportedOperationException.class)
+	public void clientSetNameWorksCorrectly() {
+		super.clientSetNameWorksCorrectly();
+	}
+
 }

src/test/java/org/springframework/data/redis/connection/jredis/JRedisConnectionIntegrationTests.java

@@ -809,4 +809,13 @@ public void testExecuteShouldConvertArrayReplyCorrectly() {
 	public void testPsetEx() throws Exception {
 		super.testPsetEx();
 	}
+
+	/**
+	 * @see DATAREDIS-269
+	 */
+	@Override
+	@Test(expected = UnsupportedOperationException.class)
+	public void clientSetNameWorksCorrectly() {
+		super.clientSetNameWorksCorrectly();
+	}
 }