/*
* Copyright 2017 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.jedis;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.concurrent.ThreadLocalRandom;
import java.util.concurrent.TimeUnit;
import org.springframework.dao.DataAccessException;
import org.springframework.dao.InvalidDataAccessApiUsageException;
import org.springframework.data.redis.connection.ClusterSlotHashUtil;
import org.springframework.data.redis.connection.DataType;
import org.springframework.data.redis.connection.RedisClusterNode;
import org.springframework.data.redis.connection.RedisKeyCommands;
import org.springframework.data.redis.connection.RedisNode;
import org.springframework.data.redis.connection.SortParameters;
import org.springframework.data.redis.connection.convert.Converters;
import org.springframework.data.redis.connection.jedis.JedisClusterConnection.JedisClusterCommandCallback;
import org.springframework.data.redis.connection.jedis.JedisClusterConnection.JedisMultiKeyClusterCommandCallback;
import org.springframework.data.redis.core.Cursor;
import org.springframework.data.redis.core.ScanOptions;
import org.springframework.util.Assert;
import org.springframework.util.CollectionUtils;
/**
* @author Christoph Strobl
* @since 2.0
*/
class JedisClusterKeyCommands implements RedisKeyCommands {
private final JedisClusterConnection connection;
public JedisClusterKeyCommands(JedisClusterConnection connection) {
this.connection = connection;
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.RedisKeyCommands#del(byte[][])
*/
@Override
public Long del(byte[]... keys) {
Assert.noNullElements(keys, "Keys must not be null or contain null key!");
if (ClusterSlotHashUtil.isSameSlotForAllKeys(keys)) {
try {
return connection.getCluster().del(keys);
} catch (Exception ex) {
throw convertJedisAccessException(ex);
}
}
return (long) connection.getClusterCommandExecutor()
.executeMuliKeyCommand((JedisMultiKeyClusterCommandCallback<Long>) (client, key) -> client.del(key),
Arrays.asList(keys))
.resultsAsList().size();
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.RedisKeyCommands#type(byte[])
*/
@Override
public DataType type(byte[] key) {
try {
return JedisConverters.toDataType(connection.getCluster().type(key));
} catch (Exception ex) {
throw convertJedisAccessException(ex);
}
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.RedisKeyCommands#keys(byte[])
*/
@Override
public Set<byte[]> keys(final byte[] pattern) {
Assert.notNull(pattern, "Pattern must not be null!");
Collection<Set<byte[]>> keysPerNode = connection.getClusterCommandExecutor()
.executeCommandOnAllNodes((JedisClusterCommandCallback<Set<byte[]>>) client -> client.keys(pattern))
.resultsAsList();
Set<byte[]> keys = new HashSet<>();
for (Set<byte[]> keySet : keysPerNode) {
keys.addAll(keySet);
}
return keys;
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.RedisClusterConnection#keys(org.springframework.data.redis.connection.RedisClusterNode, byte[])
*/
public Set<byte[]> keys(RedisClusterNode node, final byte[] pattern) {
Assert.notNull(pattern, "Pattern must not be null!");
return connection.getClusterCommandExecutor()
.executeCommandOnSingleNode((JedisClusterCommandCallback<Set<byte[]>>) client -> client.keys(pattern), node)
.getValue();
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.RedisKeyCommands#scan(org.springframework.data.redis.core.ScanOptions)
*/
@Override
public Cursor<byte[]> scan(ScanOptions options) {
throw new InvalidDataAccessApiUsageException("Scan is not supported across multiple nodes within a cluster");
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.RedisKeyCommands#randomKey()
*/
@Override
public byte[] randomKey() {
List<RedisClusterNode> nodes = new ArrayList<>(
connection.getTopologyProvider().getTopology().getActiveMasterNodes());
Set<RedisNode> inspectedNodes = new HashSet<>(nodes.size());
do {
RedisClusterNode node = nodes.get(ThreadLocalRandom.current().nextInt(nodes.size()));
while (inspectedNodes.contains(node)) {
node = nodes.get(ThreadLocalRandom.current().nextInt(nodes.size()));
}
inspectedNodes.add(node);
byte[] key = randomKey(node);
if (key != null && key.length > 0) {
return key;
}
} while (nodes.size() != inspectedNodes.size());
return null;
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.RedisClusterConnection#randomKey(org.springframework.data.redis.connection.RedisClusterNode)
*/
public byte[] randomKey(RedisClusterNode node) {
return connection.getClusterCommandExecutor()
.executeCommandOnSingleNode((JedisClusterCommandCallback<byte[]>) client -> client.randomBinaryKey(), node)
.getValue();
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.RedisKeyCommands#rename(byte[], byte[])
*/
@Override
public void rename(final byte[] sourceKey, final byte[] targetKey) {
if (ClusterSlotHashUtil.isSameSlotForAllKeys(sourceKey, targetKey)) {
try {
connection.getCluster().rename(sourceKey, targetKey);
return;
} catch (Exception ex) {
throw convertJedisAccessException(ex);
}
}
byte[] value = dump(sourceKey);
if (value != null && value.length > 0) {
restore(targetKey, 0, value);
del(sourceKey);
}
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.RedisKeyCommands#renameNX(byte[], byte[])
*/
@Override
public Boolean renameNX(final byte[] sourceKey, final byte[] targetKey) {
if (ClusterSlotHashUtil.isSameSlotForAllKeys(sourceKey, targetKey)) {
try {
return JedisConverters.toBoolean(connection.getCluster().renamenx(sourceKey, targetKey));
} catch (Exception ex) {
throw convertJedisAccessException(ex);
}
}
byte[] value = dump(sourceKey);
if (value != null && value.length > 0 && !exists(targetKey)) {
restore(targetKey, 0, value);
del(sourceKey);
return Boolean.TRUE;
}
return Boolean.FALSE;
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.RedisKeyCommands#expire(byte[], long)
*/
@Override
public Boolean expire(byte[] key, long seconds) {
if (seconds > Integer.MAX_VALUE) {
throw new UnsupportedOperationException("Jedis does not support seconds exceeding Integer.MAX_VALUE.");
}
try {
return JedisConverters.toBoolean(connection.getCluster().expire(key, Long.valueOf(seconds).intValue()));
} catch (Exception ex) {
throw convertJedisAccessException(ex);
}
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.RedisKeyCommands#pExpire(byte[], long)
*/
@Override
public Boolean pExpire(final byte[] key, final long millis) {
try {
return JedisConverters.toBoolean(connection.getCluster().pexpire(key, millis));
} catch (Exception ex) {
throw convertJedisAccessException(ex);
}
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.RedisKeyCommands#expireAt(byte[], long)
*/
@Override
public Boolean expireAt(byte[] key, long unixTime) {
try {
return JedisConverters.toBoolean(connection.getCluster().expireAt(key, unixTime));
} catch (Exception ex) {
throw convertJedisAccessException(ex);
}
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.RedisKeyCommands#pExpireAt(byte[], long)
*/
@Override
public Boolean pExpireAt(byte[] key, long unixTimeInMillis) {
try {
return JedisConverters.toBoolean(connection.getCluster().pexpireAt(key, unixTimeInMillis));
} catch (Exception ex) {
throw convertJedisAccessException(ex);
}
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.RedisKeyCommands#persist(byte[])
*/
@Override
public Boolean persist(byte[] key) {
try {
return JedisConverters.toBoolean(connection.getCluster().persist(key));
} catch (Exception ex) {
throw convertJedisAccessException(ex);
}
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.RedisKeyCommands#move(byte[], int)
*/
@Override
public Boolean move(byte[] key, int dbIndex) {
throw new UnsupportedOperationException("Cluster mode does not allow moving keys.");
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.RedisKeyCommands#ttl(byte[])
*/
@Override
public Long ttl(byte[] key) {
try {
return connection.getCluster().ttl(key);
} catch (Exception ex) {
throw convertJedisAccessException(ex);
}
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.RedisKeyCommands#ttl(byte[], java.util.concurrent.TimeUnit)
*/
@Override
public Long ttl(byte[] key, TimeUnit timeUnit) {
try {
return Converters.secondsToTimeUnit(connection.getCluster().ttl(key), timeUnit);
} catch (Exception ex) {
throw convertJedisAccessException(ex);
}
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.RedisKeyCommands#pTtl(byte[])
*/
@Override
public Long pTtl(final byte[] key) {
return connection.getClusterCommandExecutor()
.executeCommandOnSingleNode((JedisClusterCommandCallback<Long>) client -> client.pttl(key),
connection.getTopologyProvider().getTopology().getKeyServingMasterNode(key))
.getValue();
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.RedisKeyCommands#pTtl(byte[], java.util.concurrent.TimeUnit)
*/
@Override
public Long pTtl(final byte[] key, final TimeUnit timeUnit) {
return connection.getClusterCommandExecutor()
.executeCommandOnSingleNode(
(JedisClusterCommandCallback<Long>) client -> Converters.millisecondsToTimeUnit(client.pttl(key), timeUnit),
connection.getTopologyProvider().getTopology().getKeyServingMasterNode(key))
.getValue();
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.RedisKeyCommands#dump(byte[])
*/
@Override
public byte[] dump(final byte[] key) {
return connection.getClusterCommandExecutor()
.executeCommandOnSingleNode((JedisClusterCommandCallback<byte[]>) client -> client.dump(key),
connection.getTopologyProvider().getTopology().getKeyServingMasterNode(key))
.getValue();
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.RedisKeyCommands#restore(byte[], long, byte[])
*/
@Override
public void restore(final byte[] key, final long ttlInMillis, final byte[] serializedValue) {
if (ttlInMillis > Integer.MAX_VALUE) {
throw new UnsupportedOperationException("Jedis does not support ttlInMillis exceeding Integer.MAX_VALUE.");
}
connection.getClusterCommandExecutor()
.executeCommandOnSingleNode((JedisClusterCommandCallback<String>) client -> client.restore(key,
Long.valueOf(ttlInMillis).intValue(), serializedValue), connection.clusterGetNodeForKey(key));
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.RedisKeyCommands#sort(byte[], org.springframework.data.redis.connection.SortParameters)
*/
@Override
public List<byte[]> sort(byte[] key, SortParameters params) {
try {
return connection.getCluster().sort(key, JedisConverters.toSortingParams(params));
} catch (Exception ex) {
throw convertJedisAccessException(ex);
}
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.RedisKeyCommands#sort(byte[], org.springframework.data.redis.connection.SortParameters, byte[])
*/
@Override
public Long sort(byte[] key, SortParameters params, byte[] storeKey) {
List<byte[]> sorted = sort(key, params);
if (!CollectionUtils.isEmpty(sorted)) {
byte[][] arr = new byte[sorted.size()][];
switch (type(key)) {
case SET:
connection.setCommands().sAdd(storeKey, sorted.toArray(arr));
return 1L;
case LIST:
connection.listCommands().lPush(storeKey, sorted.toArray(arr));
return 1L;
default:
throw new IllegalArgumentException("sort and store is only supported for SET and LIST");
}
}
return 0L;
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.RedisKeyCommands#exists(byte[])
*/
@Override
public Boolean exists(final byte[] key) {
try {
return connection.getCluster().exists(key);
} catch (Exception ex) {
throw convertJedisAccessException(ex);
}
}
private DataAccessException convertJedisAccessException(Exception ex) {
return connection.convertJedisAccessException(ex);
}
}