Package io.valkey.springframework.data.valkey.connection

Class ClusterSlotHashUtil

java.lang.Object

io.valkey.springframework.data.valkey.connection.ClusterSlotHashUtil

public abstract class ClusterSlotHashUtil
extends Object

Utility class encapsulating functionality commonly used for cluster slot hashing.

Since:

1.7

Author:

Christoph Strobl, John Blum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	SLOT_COUNT
protected static final byte	SUBKEY_END
protected static final byte	SUBKEY_START

Constructor Summary

Constructors

Constructor	Description
ClusterSlotHashUtil()

Method Summary

Modifier and Type	Method	Description
static int	calculateSlot(byte[] key)	Calculate the slot from the given key.
static int	calculateSlot(String key)	Calculate the slot from the given key.
static String	getKeyForSlot(int targetSlot)	Generates a key that will map to the specified cluster slot.
static boolean	isSameSlotForAllKeys(byte[]... keys)	Determines whether all keys will hash to the same slot.
static boolean	isSameSlotForAllKeys(ByteBuffer... keys)	Determines whether all keys will hash to the same slot.
static boolean	isSameSlotForAllKeys(Collection<ByteBuffer> keys)	Determines whether all keys will hash to the same slot.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SLOT_COUNT

public static final int SLOT_COUNT

See Also:

• Constant Field Values

SUBKEY_START

protected static final byte SUBKEY_START

See Also:

• Constant Field Values

SUBKEY_END

protected static final byte SUBKEY_END

See Also:

• Constant Field Values

Constructor Details

ClusterSlotHashUtil

public ClusterSlotHashUtil()

Method Details

isSameSlotForAllKeys

public static boolean isSameSlotForAllKeys(byte[]... keys)

Determines whether all keys will hash to the same slot.

Parameters:

keys - array of keys to evaluate3; must not be null.

Returns:

a boolean value indicating whether all keys will hash to the same slot.

Throws:

IllegalArgumentException - if the byte array of keys is null.

isSameSlotForAllKeys

public static boolean isSameSlotForAllKeys(ByteBuffer... keys)

Determines whether all keys will hash to the same slot.

Parameters:

keys - array of ByteBuffer objects containing the keys to evaluate; must not be null.

Returns:

a boolean value indicating whether all keys will hash to the same slot.

Throws:

IllegalArgumentException - if the array of keys is null.

Since:

2.0

See Also:

• isSameSlotForAllKeys(Collection)

isSameSlotForAllKeys

public static boolean isSameSlotForAllKeys(Collection<ByteBuffer> keys)

Determines whether all keys will hash to the same slot.

Parameters:

keys - Collection of ByteBuffer objects containing the keys to evaluate; must not be null.

Returns:

a boolean value indicating whether all keys will hash to the same slot.

Throws:

IllegalArgumentException - if the Collection of keys is null.

Since:

2.0

calculateSlot

public static int calculateSlot(String key)

Calculate the slot from the given key.

Parameters:

key - String containing the Valkey key to evaluate; must not be null or empty.

Returns:

the computed slot based on the given key.

Throws:

IllegalArgumentException - if the given key is null or empty.

See Also:

• calculateSlot(byte[])

calculateSlot

public static int calculateSlot(byte[] key)

Calculate the slot from the given key.

Parameters:

key - array of bytes containing the Valkey key to evaluate; must not be null.

Returns:

the computed slot based on the given key.

getKeyForSlot

public static String getKeyForSlot(int targetSlot)

Generates a key that will map to the specified cluster slot. This method iterates through key patterns until it finds one that matches the target slot.

Parameters:

targetSlot - the target slot number (0-16383)

Returns:

a key string that will hash to the specified slot

Throws:

IllegalArgumentException - if slot is not in valid range [0, 16383]