DATAREDIS-552 - Polishing.

Apply client name to Sentinel and unpooled connections if set. Add ticket references to JavaDoc. Add tests. Fix existing JavaDoc letter casing and punctuation. Rearrange isClusterAware/isRedisSentinelAware methods.

Author: mp911de

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

@@ -68,6 +68,7 @@
 import org.springframework.util.CollectionUtils;
 import org.springframework.util.ObjectUtils;
 import org.springframework.util.ReflectionUtils;
+import org.springframework.util.StringUtils;
 
 import redis.clients.jedis.BinaryJedis;
 import redis.clients.jedis.BinaryJedisPubSub;
@@ -149,6 +150,7 @@ public class JedisConnection extends AbstractRedisConnection {
 private volatile JedisSubscription subscription;
 private volatile Pipeline pipeline;
 private final int dbIndex;
+private final String clientName;
 private boolean convertPipelineAndTxResults = true;
 private List<FutureResult<Response<?>>> pipelinedResults = new ArrayList<FutureResult<Response<?>>>();
 private Queue<FutureResult<Response<?>>> txResults = new LinkedList<FutureResult<Response<?>>>();
@@ -192,15 +194,30 @@ public JedisConnection(Jedis jedis) {
  *
  * @param jedis
  * @param pool can be null, if no pool is used
+ * @param dbIndex
  */
 public JedisConnection(Jedis jedis, Pool<Jedis> pool, int dbIndex) {
-this.jedis = jedis;
+this(jedis, pool, dbIndex, null);
+}
+
+/**
+ * Constructs a new <code>JedisConnection</code> instance backed by a jedis pool.
+ *
+ * @param jedis
+ * @param pool can be null, if no pool is used
+ * @param dbIndex
+ * @param clientName the client name, can be {@literal null}.
+ * @since 1.8
+ */
+protected JedisConnection(Jedis jedis, Pool<Jedis> pool, int dbIndex, String clientName) {
+
 // extract underlying connection for batch operations
 client = (Client) ReflectionUtils.getField(CLIENT_FIELD, jedis);
 
+this.jedis = jedis;
 this.pool = pool;
-
 this.dbIndex = dbIndex;
+this.clientName = clientName;
 
 // select the db
 // if this fail, do manual clean-up before propagating the exception
@@ -3988,7 +4005,14 @@ protected JedisSentinelConnection getSentinelConnection(RedisNode sentinel) {
 }
 
 protected Jedis getJedis(RedisNode node) {
-return new Jedis(node.getHost(), node.getPort());
+
+Jedis jedis = new Jedis(node.getHost(), node.getPort());
+
+if (StringUtils.hasText(clientName)) {
+jedis.clientSetname(clientName);
+}
+
+return jedis;
 }
 
 @Override

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

@@ -193,9 +193,12 @@ protected Jedis fetchJedisConnector() {
 if (usePool && pool != null) {
 return pool.getResource();
 }
+
 Jedis jedis = new Jedis(getShardInfo());
 // force initialization (see Jedis issue #82)
 jedis.connect();
+
+potentiallySetClientName(jedis);
 return jedis;
 } catch (Exception ex) {
 throw new RedisConnectionFailureException("Cannot get Jedis connection", ex);
@@ -343,8 +346,8 @@ public RedisConnection getConnection() {
 }
 
 Jedis jedis = fetchJedisConnector();
-JedisConnection connection = (usePool ? new JedisConnection(jedis, pool, dbIndex)
-: new JedisConnection(jedis, null, dbIndex));
+JedisConnection connection = (usePool ? new JedisConnection(jedis, pool, dbIndex, clientName)
+: new JedisConnection(jedis, null, dbIndex, clientName));
 connection.setConvertPipelineAndTxResults(convertPipelineAndTxResults);
 return postProcessConnection(connection);
 }
@@ -373,7 +376,7 @@ public DataAccessException translateExceptionIfPossible(RuntimeException ex) {
 /**
  * Returns the Redis hostName.
  * 
- * @return Returns the hostName
+ * @return the hostName.
  */
 public String getHostName() {
 return hostName;
@@ -382,7 +385,7 @@ public String getHostName() {
 /**
  * Sets the Redis hostName.
  * 
- * @param hostName The hostName to set.
+ * @param hostName the hostName to set.
  */
 public void setHostName(String hostName) {
 this.hostName = hostName;
@@ -401,7 +404,7 @@ public void setUseSsl(boolean useSsl) {
 /**
  * Returns whether to use SSL.
  *
- * @return use of SSL
+ * @return use of SSL.
  * @since 1.8
  */
 public boolean isUseSsl() {
@@ -411,7 +414,7 @@ public boolean isUseSsl() {
 /**
  * Returns the password used for authenticating with the Redis server.
  * 
- * @return password for authentication
+ * @return password for authentication.
  */
 public String getPassword() {
 return password;
@@ -420,7 +423,7 @@ public String getPassword() {
 /**
  * Sets the password used for authenticating with the Redis server.
  * 
- * @param password the password to set
+ * @param password the password to set.
  */
 public void setPassword(String password) {
 this.password = password;
@@ -429,7 +432,7 @@ public void setPassword(String password) {
 /**
  * Returns the port used to connect to the Redis instance.
  * 
- * @return Redis port.
+ * @return the Redis port.
  */
 public int getPort() {
 return port;
@@ -438,7 +441,7 @@ public int getPort() {
 /**
  * Sets the port used to connect to the Redis instance.
  * 
- * @param port Redis port
+ * @param port the Redis port.
  */
 public void setPort(int port) {
 this.port = port;
@@ -447,7 +450,7 @@ public void setPort(int port) {
 /**
  * Returns the shardInfo.
  * 
- * @return Returns the shardInfo
+ * @return the shardInfo.
  */
 public JedisShardInfo getShardInfo() {
 return shardInfo;
@@ -456,7 +459,7 @@ public JedisShardInfo getShardInfo() {
 /**
  * Sets the shard info for this factory.
  * 
- * @param shardInfo The shardInfo to set.
+ * @param shardInfo the shardInfo to set.
  */
 public void setShardInfo(JedisShardInfo shardInfo) {
 this.shardInfo = shardInfo;
@@ -465,14 +468,16 @@ public void setShardInfo(JedisShardInfo shardInfo) {
 /**
  * Returns the timeout.
  * 
- * @return Returns the timeout
+ * @return the timeout.
  */
 public int getTimeout() {
 return timeout;
 }
 
 /**
- * @param timeout The timeout to set.
+ * Sets the timeout.
+ *
+ * @param timeout the timeout to set.
  */
 public void setTimeout(int timeout) {
 this.timeout = timeout;
@@ -481,7 +486,7 @@ public void setTimeout(int timeout) {
 /**
  * Indicates the use of a connection pool.
  * 
- * @return Returns the use of connection pooling.
+ * @return the use of connection pooling.
  */
 public boolean getUsePool() {
 return usePool;
@@ -490,7 +495,7 @@ public boolean getUsePool() {
 /**
  * Turns on or off the use of connection pooling.
  * 
- * @param usePool The usePool to set.
+ * @param usePool the usePool to set.
  */
 public void setUsePool(boolean usePool) {
 this.usePool = usePool;
@@ -499,7 +504,7 @@ public void setUsePool(boolean usePool) {
 /**
  * Returns the poolConfig.
  * 
- * @return Returns the poolConfig
+ * @return the poolConfig
  */
 public JedisPoolConfig getPoolConfig() {
 return poolConfig;
@@ -508,7 +513,7 @@ public JedisPoolConfig getPoolConfig() {
 /**
  * Sets the pool configuration for this factory.
  * 
- * @param poolConfig The poolConfig to set.
+ * @param poolConfig the poolConfig to set.
  */
 public void setPoolConfig(JedisPoolConfig poolConfig) {
 this.poolConfig = poolConfig;
@@ -517,7 +522,7 @@ public void setPoolConfig(JedisPoolConfig poolConfig) {
 /**
  * Returns the index of the database.
  * 
- * @return Returns the database index
+ * @return the database index.
  */
 public int getDatabase() {
 return dbIndex;
@@ -526,26 +531,28 @@ public int getDatabase() {
 /**
  * Sets the index of the database used by this connection factory. Default is 0.
  * 
- * @param index database index
+ * @param index database index.
  */
 public void setDatabase(int index) {
 Assert.isTrue(index >= 0, "invalid DB index (a positive index required)");
 this.dbIndex = index;
 }
-
+
 /**
  * Returns the client name.
- * 
- * @return Returns the client name
+ *
+ * @return the client name.
+ * @since 1.8
  */
 public String getClientName() {
 return clientName;
 }
 
 /**
- * Sets the client name used by this connection factory. Default is empty.
- * 
- * @param clientName client name
+ * Sets the client name used by this connection factory. Defaults to none which does not set a client name.
+ *
+ * @param clientName the client name.
+ * @since 1.8
  */
 public void setClientName(String clientName) {
 this.clientName = clientName;
@@ -554,9 +561,9 @@ public void setClientName(String clientName) {
 /**
  * Specifies if pipelined results should be converted to the expected data type. If false, results of
  * {@link JedisConnection#closePipeline()} and {@link JedisConnection#exec()} will be of the type returned by the
- * Jedis driver
+ * Jedis driver.
  * 
- * @return Whether or not to convert pipeline and tx results
+ * @return Whether or not to convert pipeline and tx results.
  */
 public boolean getConvertPipelineAndTxResults() {
 return convertPipelineAndTxResults;
@@ -565,9 +572,9 @@ public boolean getConvertPipelineAndTxResults() {
 /**
  * Specifies if pipelined results should be converted to the expected data type. If false, results of
  * {@link JedisConnection#closePipeline()} and {@link JedisConnection#exec()} will be of the type returned by the
- * Jedis driver
+ * Jedis driver.
  * 
- * @param convertPipelineAndTxResults Whether or not to convert pipeline and tx results
+ * @param convertPipelineAndTxResults Whether or not to convert pipeline and tx results.
  */
 public void setConvertPipelineAndTxResults(boolean convertPipelineAndTxResults) {
 this.convertPipelineAndTxResults = convertPipelineAndTxResults;
@@ -597,14 +604,19 @@ public RedisSentinelConnection getSentinelConnection() {
 private Jedis getActiveSentinel() {
 
 Assert.notNull(this.sentinelConfig);
+
 for (RedisNode node : this.sentinelConfig.getSentinels()) {
+
 Jedis jedis = new Jedis(node.getHost(), node.getPort());
+
 if (jedis.ping().equalsIgnoreCase("pong")) {
+
+potentiallySetClientName(jedis);
 return jedis;
 }
 }
 
-throw new InvalidDataAccessResourceUsageException("no sentinel found");
+throw new InvalidDataAccessResourceUsageException("No Sentinel found");
 }
 
 private Set<String> convertToJedisSentinelSet(Collection<RedisNode> nodes) {
@@ -622,6 +634,13 @@ private Set<String> convertToJedisSentinelSet(Collection<RedisNode> nodes) {
 return convertedNodes;
 }
 
+private void potentiallySetClientName(Jedis jedis) {
+
+if (StringUtils.hasText(clientName)) {
+jedis.clientSetname(clientName);
+}
+}
+
 private void setTimeoutOn(JedisShardInfo shardInfo, int timeout) {
 ReflectionUtils.invokeMethod(SET_TIMEOUT_METHOD, shardInfo, timeout);
 }