org.infinispan.distribution

Interface DistributionManager

All Known Implementing Classes:

DistributionManagerImpl

public interface DistributionManager

A component that manages the distribution of elements across a cache cluster

Since:

4.0

Author:

Manik Surtani, Mircea.Markus@jboss.com, Vladimir Blagojevic, anistor@redhat.com

Method Summary

Methods

Modifier and Type	Method and Description
ConsistentHash	getConsistentHash() Retrieves the consistent hash instance currently in use, an instance of the configured ConsistentHash class (which defaults to DefaultConsistentHash.
DataLocality	getLocality(Object key) Returns the data locality characteristics of a given key.
Address	getPrimaryLocation(Object key) Returns the first Address containing the key.
ConsistentHash	getReadConsistentHash()
ConsistentHash	getWriteConsistentHash()
boolean	isAffectedByRehash(Object key) Tests whether a given key is affected by a rehash that may be in progress.
boolean	isJoinComplete() Tests whether the current instance has completed joining the cluster
boolean	isRehashInProgress() Tests whether a rehash is in progress
List<Address>	locate(Object key) Locates a key in a cluster.
Set<Address>	locateAll(Collection<Object> keys) Locates a list of keys in a cluster.

Method Detail

getLocality

DataLocality getLocality(Object key)

Returns the data locality characteristics of a given key.

Parameters:

key - key to test

Returns:

a DataLocality that allows you to test whether a key is mapped to the local node or not, and the degree of certainty of such a result.

locate

List<Address> locate(Object key)

Locates a key in a cluster. The returned addresses may not be owners of the keys if a rehash happens to be in progress or is pending, so when querying these servers, invalid responses should be checked for and the next address checked accordingly.

Parameters:

key - key to test

Returns:

a list of addresses where the key may reside

getPrimaryLocation

Address getPrimaryLocation(Object key)

Returns the first Address containing the key. Equivalent to returning the first element of locate(Object)

Parameters:

key - key to test

Returns:

the first address on which the key may reside

locateAll

Set<Address> locateAll(Collection<Object> keys)

Locates a list of keys in a cluster. Like locate(Object) the returned addresses may not be owners of the keys if a rehash happens to be in progress or is pending, so when querying these servers, invalid responses should be checked for and the next address checked accordingly.

Parameters:

keys - list of keys to locate

Returns:

a list of addresses where the keys reside

getConsistentHash

ConsistentHash getConsistentHash()

Retrieves the consistent hash instance currently in use, an instance of the configured ConsistentHash class (which defaults to DefaultConsistentHash.

Returns:

a ConsistentHash instance

getReadConsistentHash

ConsistentHash getReadConsistentHash()

getWriteConsistentHash

ConsistentHash getWriteConsistentHash()

isAffectedByRehash

boolean isAffectedByRehash(Object key)

Tests whether a given key is affected by a rehash that may be in progress. If no rehash is in progress, this method returns false. Helps determine whether additional steps are necessary in handling an operation with a given key.

Parameters:

key - key to test

Returns:

whether a key is affected by a rehash

isRehashInProgress

boolean isRehashInProgress()

Tests whether a rehash is in progress

Returns:

true if a rehash is in progress, false otherwise

isJoinComplete

boolean isJoinComplete()

Tests whether the current instance has completed joining the cluster

Returns:

true if join is in progress, false otherwise