org.infinispan.distribution.group

Class PartitionerConsistentHash

java.lang.Object

org.infinispan.distribution.group.PartitionerConsistentHash

All Implemented Interfaces:

ConsistentHash

public class PartitionerConsistentHash
extends Object
implements ConsistentHash

ConsistentHash wrapper that uses a KeyPartitioner instead of a Hash.

Since:

8.2

Author:

Dan Berindei

Constructor Summary

Constructors

Constructor and Description
PartitionerConsistentHash(ConsistentHash ch, KeyPartitioner keyPartitioner)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Hash	getHashFunction()
KeyPartitioner	getKeyPartitioner()
List<Address>	getMembers() Should return the addresses of the nodes used to create this consistent hash.
int	getNumOwners()
int	getNumSegments()
Set<Integer>	getPrimarySegmentsForOwner(Address owner) Returns the segments that this cache member is the primary owner for.
String	getRoutingTableAsString() Returns a string containing all the segments and their associated addresses.
int	getSegment(Object key)
Set<Integer>	getSegmentsForOwner(Address owner) Returns the segments owned by a cache member.
int	hashCode()
boolean	isKeyLocalToNode(Address nodeAddress, Object key) Test to see whether a key is owned by a given node.
boolean	isReplicated()
boolean	isSegmentLocalToNode(Address nodeAddress, int segmentId) Check if a segment is local to a given member.
List<Address>	locateOwnersForSegment(int segmentId)
Address	locatePrimaryOwnerForSegment(int segmentId)
void	toScopedState(ScopedPersistentState state) Writes this ConsistentHash to the specified scoped state.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.infinispan.distribution.ch.ConsistentHash

locateAllOwners, locateOwners, locatePrimaryOwner

Constructor Detail

PartitionerConsistentHash

public PartitionerConsistentHash(ConsistentHash ch,
                                 KeyPartitioner keyPartitioner)

Method Detail

getNumSegments

public int getNumSegments()

Specified by:

getNumSegments in interface ConsistentHash

Returns:

The actual number of hash space segments. Note that it may not be the same as the number of segments passed in at creation time.

getNumOwners

public int getNumOwners()

Specified by:

getNumOwners in interface ConsistentHash

Returns:

The configured number of owners for each key. Note that {code @getOwners(key)} may return a different number of owners.

getMembers

public List<Address> getMembers()

Description copied from interface: ConsistentHash

Should return the addresses of the nodes used to create this consistent hash.

Specified by:

getMembers in interface ConsistentHash

Returns:

set of node addresses.

getSegment

public int getSegment(Object key)

Specified by:

getSegment in interface ConsistentHash

Returns:

The hash space segment that a key maps to.

locateOwnersForSegment

public List<Address> locateOwnersForSegment(int segmentId)

Specified by:

locateOwnersForSegment in interface ConsistentHash

Returns:

All the nodes that own a given hash space segment, first address is the primary owner. The returned list is unmodifiable.

locatePrimaryOwnerForSegment

public Address locatePrimaryOwnerForSegment(int segmentId)

Specified by:

locatePrimaryOwnerForSegment in interface ConsistentHash

Returns:

The primary owner of a given hash space segment. This is equivalent to locateOwnersForSegment(segmentId).get(0) but is more efficient

isSegmentLocalToNode

public boolean isSegmentLocalToNode(Address nodeAddress,
                                    int segmentId)

Description copied from interface: ConsistentHash

Check if a segment is local to a given member.

Implementation note: normally key-based method are implemented based on segment-based methods. Here, however, we need a default implementation for the segment-based method for backwards-compatibility reasons.

Specified by:

isSegmentLocalToNode in interface ConsistentHash

isReplicated

public boolean isReplicated()

Specified by:

isReplicated in interface ConsistentHash

Returns:

true if every member owns every segment. This allows callers to skip computing the segment of a key in some cases.

getSegmentsForOwner

public Set<Integer> getSegmentsForOwner(Address owner)

Description copied from interface: ConsistentHash

Returns the segments owned by a cache member.

Specified by:

getSegmentsForOwner in interface ConsistentHash

Parameters:

owner - the address of the member

Returns:

a non-null set of segment IDs, may or may not be unmodifiable, which shouldn't be modified by caller

getPrimarySegmentsForOwner

public Set<Integer> getPrimarySegmentsForOwner(Address owner)

Description copied from interface: ConsistentHash

Returns the segments that this cache member is the primary owner for.

Specified by:

getPrimarySegmentsForOwner in interface ConsistentHash

Parameters:

owner - the address of the member

Returns:

a non-null set of segment IDs, may or may not be unmodifiable, which shouldn't be modified by caller

getRoutingTableAsString

public String getRoutingTableAsString()

Description copied from interface: ConsistentHash

Returns a string containing all the segments and their associated addresses.

Specified by:

getRoutingTableAsString in interface ConsistentHash

isKeyLocalToNode

public boolean isKeyLocalToNode(Address nodeAddress,
                                Object key)

Description copied from interface: ConsistentHash

Test to see whether a key is owned by a given node.

Specified by:

isKeyLocalToNode in interface ConsistentHash

Parameters:

nodeAddress - address of the node to test

key - key to test

Returns:

true if the key is mapped to the address; false otherwise

getHashFunction

public Hash getHashFunction()

Specified by:

getHashFunction in interface ConsistentHash

getKeyPartitioner

public KeyPartitioner getKeyPartitioner()

toScopedState

public void toScopedState(ScopedPersistentState state)

Description copied from interface: ConsistentHash

Writes this ConsistentHash to the specified scoped state.

Specified by:

toScopedState in interface ConsistentHash

Parameters:

state - the state to which this ConsistentHash will be written

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object