DATAREDIS-330 - Add support for SENTINEL commands.

add support for commands: SENTINEL FAILOVER master SENTINEL SLAVES master SENTINEL REMOVE name SENTINEL MONITOR name ip port quorum Original pull request: spring-projects#92.

Author: christophstrobl

docs/src/reference/docbook/reference/redis.xml

@@ -222,6 +222,8 @@ public RedisConnectionFactory jedisConnectionFactory() {
  return new JedisConnectionFactory(sentinelConfig);
 } 
  ]]></programlisting>
+ <para>Sometimes direct interaction with the one of the Sentinels is required. Using <classname>RedisConnectionFactory.getSentinelConnection()</classname> or 
+ <classname>RedisConnection.getSentinelCommands()</classname> gives you access to the first active Sentinel configured.</para>
  </section>
 
  <section id="redis:template">

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

@@ -0,0 +1,115 @@
+/*
+ * 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.io.IOException;
+import java.util.concurrent.ConcurrentHashMap;
+
+import org.springframework.dao.DataAccessException;
+import org.springframework.dao.InvalidDataAccessApiUsageException;
+import org.springframework.dao.InvalidDataAccessResourceUsageException;
+import org.springframework.data.redis.RedisSystemException;
+
+/**
+ * @author Christoph Strobl
+ * @since 1.4
+ */
+public abstract class AbstractRedisConnection implements RedisConnection {
+
+private RedisSentinelConfiguration sentinelConfiguration;
+private ConcurrentHashMap<RedisNode, RedisSentinelConnection> connectionCache = new ConcurrentHashMap<RedisNode, RedisSentinelConnection>();
+
+/*
+ * (non-Javadoc)
+ * @see org.springframework.data.redis.connection.RedisConnection#getSentinelCommands()
+ */
+@Override
+public RedisSentinelConnection getSentinelConnection() {
+
+if (!hasRedisSentinelConfigured()) {
+throw new InvalidDataAccessResourceUsageException("No sentinels configured.");
+}
+
+RedisNode node = selectActiveSentinel();
+RedisSentinelConnection connection = connectionCache.get(node);
+if (connection == null || !connection.isOpen()) {
+connection = getSentinelConnection(node);
+connectionCache.putIfAbsent(node, connection);
+}
+return connection;
+}
+
+public void setSentinelConfiguration(RedisSentinelConfiguration sentinelConfiguration) {
+this.sentinelConfiguration = sentinelConfiguration;
+}
+
+public boolean hasRedisSentinelConfigured() {
+return this.sentinelConfiguration != null;
+}
+
+private RedisNode selectActiveSentinel() {
+
+for (RedisNode node : this.sentinelConfiguration.getSentinels()) {
+if (isActive(node)) {
+return node;
+}
+}
+
+throw new InvalidDataAccessApiUsageException("Could not find any active sentinels");
+}
+
+/**
+ * Check if node is active by sending ping.
+ * 
+ * @param node
+ * @return
+ */
+protected boolean isActive(RedisNode node) {
+return false;
+}
+
+/**
+ * Get {@link RedisSentinelCommands} connected to given node.
+ * 
+ * @param sentinel
+ * @return
+ */
+protected RedisSentinelConnection getSentinelConnection(RedisNode sentinel) {
+throw new UnsupportedOperationException("Sentinel is not supported by this client.");
+}
+
+/*
+ * (non-Javadoc)
+ * @see org.springframework.data.redis.connection.RedisConnection#close()
+ */
+@Override
+public void close() throws DataAccessException {
+
+if (!connectionCache.isEmpty()) {
+for (RedisNode node : connectionCache.keySet()) {
+RedisSentinelConnection connection = connectionCache.remove(node);
+if (connection.isOpen()) {
+try {
+connection.close();
+} catch (IOException e) {
+throw new RedisSystemException("Failed to close sentinel connection", e);
+}
+}
+}
+}
+}
+
+}

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

@@ -2380,4 +2380,9 @@ public Cursor<StringTuple> zScan(String key, ScanOptions options) {
 new TupleConverter());
 }
 
+@Override
+public RedisSentinelConnection getSentinelConnection() {
+return delegate.getSentinelConnection();
+}
+
 }

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

@@ -92,4 +92,10 @@ public interface RedisConnection extends RedisCommands {
  * @return the result of the executed commands.
  */
 List<Object> closePipeline() throws RedisPipelineException;
+
+/**
+ * @return
+ * @since 1.4
+ */
+RedisSentinelConnection getSentinelConnection();
 }

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2011-2013 the original author or authors.
+ * Copyright 2011-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.
@@ -22,6 +22,7 @@
  * Thread-safe factory of Redis connections.
  * 
  * @author Costin Leau
+ * @author Christoph Strobl
  */
 public interface RedisConnectionFactory extends PersistenceExceptionTranslator {
 
@@ -41,4 +42,10 @@ public interface RedisConnectionFactory extends PersistenceExceptionTranslator {
  * @return Whether or not to convert pipeline and tx results
  */
 boolean getConvertPipelineAndTxResults();
+
+/**
+ * @return
+ * @since 1.4
+ */
+RedisSentinelConnection getSentinelConnection();
 }

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

@@ -15,22 +15,37 @@
  */
 package org.springframework.data.redis.connection;
 
+import org.springframework.util.Assert;
 import org.springframework.util.ObjectUtils;
 
 /**
  * @author Christoph Strobl
+ * @author Thomas Darimont
+ * 
  * @since 1.4
  */
-public class RedisNode {
-
-private final String host;
-private final int port;
-
+public class RedisNode implements NamedNode {
+
+private String name;
+private String host;
+private int port;
+
+/**
+ * Creates a new {@link RedisNode} with the given {@code host}, {@code port}.
+ * 
+ * @param host must not be {@literal null}
+ * @param port
+ */
 public RedisNode(String host, int port) {
+
+Assert.notNull(host,"host must not be null!");
+
 this.host = host;
 this.port = port;
 }
 
+protected RedisNode() {}
+
 public String getHost() {
 return host;
 }
@@ -43,6 +58,15 @@ public String asString() {
 return host + ":" + port;
 }
 
+@Override
+public String getName() {
+return this.name;
+}
+
+public void setName(String name) {
+this.name = name;
+}
+
 @Override
 public String toString() {
 return asString();
@@ -77,7 +101,42 @@ public boolean equals(Object obj) {
 return false;
 }
 
+if (!ObjectUtils.nullSafeEquals(this.name, other.name)) {
+return false;
+}
+
 return true;
 }
 
+/**
+ * @author Christoph Strobl
+ * 
+ * @since 1.4
+ */
+public static class RedisNodeBuilder {
+
+private RedisNode node;
+
+public RedisNodeBuilder() {
+node = new RedisNode();
+}
+
+public RedisNodeBuilder withName(String name) {
+node.name = name;
+return this;
+}
+
+public RedisNodeBuilder listeningAt(String host, int port) {
+
+Assert.hasText(host, "Hostname must not be empty or null.");
+node.host = host;
+node.port = port;
+return this;
+}
+
+public RedisNode build() {
+return this.node;
+}
+}
+
 }

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

@@ -0,0 +1,64 @@
+/*
+ * 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.util.Collection;
+
+/**
+ * @author Christoph Strobl
+ * @since 1.4
+ */
+public interface RedisSentinelCommands {
+
+/**
+ * Force a failover as if the {@literal master} was not reachable.
+ * 
+ * @param master must not be {@literal null}.
+ */
+void failover(NamedNode master);
+
+/**
+ * Get a {@link Collection} of monitored masters and their state.
+ * 
+ * @return Collection of {@link RedisServer}s. Never {@literal null}.
+ */
+Collection<RedisServer> masters();
+
+/**
+ * Show list of slaves for given {@literal master}.
+ * 
+ * @param master must not be {@literal null}.
+ * @return Collection of {@link RedisServer}s. Never {@literal null}.
+ */
+Collection<RedisServer> slaves(NamedNode master);
+
+/**
+ * Removes given {@literal master}. The server will no longer be monitored and will no longer be returned by
+ * {@link #masters()}.
+ * 
+ * @param master must not be {@literal null}.
+ */
+void remove(NamedNode master);
+
+/**
+ * Tell sentinel to start monitoring a new {@literal master} with the specified {@link RedisServer#getName()},
+ * {@link RedisServer#getHost()}, {@link RedisServer#getPort()}, and {@link RedisServer#getQuorum()}.
+ * 
+ * @param master must not be {@literal null}.
+ */
+void monitor(RedisServer master);
+
+}

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

@@ -0,0 +1,31 @@
+/*
+ * 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.io.Closeable;
+
+/**
+ * @author Christoph Strobl
+ * @since 1.4
+ */
+public interface RedisSentinelConnection extends RedisSentinelCommands, Closeable {
+
+/**
+ * @return true if connected to server
+ */
+boolean isOpen();
+
+}