org.springframework.data.redis.connection.ClusterTopology Maven / Gradle / Ivy
/*
* Copyright 2015-2018 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.Arrays;
import java.util.Collections;
import java.util.LinkedHashSet;
import java.util.Set;
import org.springframework.data.redis.ClusterStateFailureException;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;
/**
* {@link ClusterTopology} holds snapshot like information about {@link RedisClusterNode}s.
*
* @author Christoph Strobl
* @author Mark Paluch
* @since 1.7
*/
public class ClusterTopology {
private final Set nodes;
/**
* Creates new instance of {@link ClusterTopology}.
*
* @param nodes can be {@literal null}.
*/
public ClusterTopology(@Nullable Set nodes) {
this.nodes = nodes != null ? nodes : Collections.emptySet();
}
/**
* Get all {@link RedisClusterNode}s.
*
* @return never {@literal null}.
*/
public Set getNodes() {
return Collections.unmodifiableSet(nodes);
}
/**
* Get all nodes (master and slave) in cluster where {@code link-state} is {@literal connected} and {@code flags} does
* not contain {@literal fail} or {@literal fail?}.
*
* @return never {@literal null}.
*/
public Set getActiveNodes() {
Set activeNodes = new LinkedHashSet<>(nodes.size());
for (RedisClusterNode node : nodes) {
if (node.isConnected() && !node.isMarkedAsFail()) {
activeNodes.add(node);
}
}
return activeNodes;
}
/**
* Get all master nodes in cluster where {@code link-state} is {@literal connected} and {@code flags} does not contain
* {@literal fail} or {@literal fail?}.
*
* @return never {@literal null}.
*/
public Set getActiveMasterNodes() {
Set activeMasterNodes = new LinkedHashSet<>(nodes.size());
for (RedisClusterNode node : nodes) {
if (node.isMaster() && node.isConnected() && !node.isMarkedAsFail()) {
activeMasterNodes.add(node);
}
}
return activeMasterNodes;
}
/**
* Get all master nodes in cluster.
*
* @return never {@literal null}.
*/
public Set getMasterNodes() {
Set masterNodes = new LinkedHashSet<>(nodes.size());
for (RedisClusterNode node : nodes) {
if (node.isMaster()) {
masterNodes.add(node);
}
}
return masterNodes;
}
/**
* Get the {@link RedisClusterNode}s (master and slave) serving s specific slot.
*
* @param slot
* @return never {@literal null}.
*/
public Set getSlotServingNodes(int slot) {
Set slotServingNodes = new LinkedHashSet<>(nodes.size());
for (RedisClusterNode node : nodes) {
if (node.servesSlot(slot)) {
slotServingNodes.add(node);
}
}
return slotServingNodes;
}
/**
* Get the {@link RedisClusterNode} that is the current master serving the given key.
*
* @param key must not be {@literal null}.
* @return never {@literal null}.
* @throws ClusterStateFailureException
*/
public RedisClusterNode getKeyServingMasterNode(byte[] key) {
Assert.notNull(key, "Key for node lookup must not be null!");
int slot = ClusterSlotHashUtil.calculateSlot(key);
for (RedisClusterNode node : nodes) {
if (node.isMaster() && node.servesSlot(slot)) {
return node;
}
}
throw new ClusterStateFailureException(
String.format("Could not find master node serving slot %s for key '%s',", slot, Arrays.toString(key)));
}
/**
* Get the {@link RedisClusterNode} matching given {@literal host} and {@literal port}.
*
* @param host must not be {@literal null}.
* @param port
* @return never {@literal null}.
* @throws ClusterStateFailureException
*/
public RedisClusterNode lookup(String host, int port) {
for (RedisClusterNode node : nodes) {
if (host.equals(node.getHost()) && (node.getPort() != null && port == node.getPort())) {
return node;
}
}
throw new ClusterStateFailureException(
String.format("Could not find node at %s:%s. Is your cluster info up to date?", host, port));
}
/**
* Get the {@link RedisClusterNode} matching given {@literal nodeId}.
*
* @param nodeId must not be {@literal null}.
* @return never {@literal null}.
* @throws ClusterStateFailureException
*/
public RedisClusterNode lookup(String nodeId) {
Assert.notNull(nodeId, "NodeId must not be null!");
for (RedisClusterNode node : nodes) {
if (nodeId.equals(node.getId())) {
return node;
}
}
throw new ClusterStateFailureException(
String.format("Could not find node at %s. Is your cluster info up to date?", nodeId));
}
/**
* Get the {@link RedisClusterNode} matching matching either {@link RedisClusterNode#getHost() host} and
* {@link RedisClusterNode#getPort() port} or {@link RedisClusterNode#getId() nodeId}
*
* @param node must not be {@literal null}
* @return never {@literal null}.
* @throws ClusterStateFailureException
*/
public RedisClusterNode lookup(RedisClusterNode node) {
Assert.notNull(node, "RedisClusterNode must not be null!");
if (nodes.contains(node) && StringUtils.hasText(node.getHost()) && StringUtils.hasText(node.getId())) {
return node;
}
if (StringUtils.hasText(node.getHost()) && node.getPort() != null) {
return lookup(node.getHost(), node.getPort());
}
if (StringUtils.hasText(node.getId())) {
return lookup(node.getId());
}
throw new ClusterStateFailureException(
String.format("Could not find node at %s. Have you provided either host and port or the nodeId?", node));
}
/**
* @param key must not be {@literal null}.
* @return {@literal null}.
*/
public Set getKeyServingNodes(byte[] key) {
Assert.notNull(key, "Key must not be null for Cluster Node lookup.");
return getSlotServingNodes(ClusterSlotHashUtil.calculateSlot(key));
}
}