org.infinispan.distribution

Class DistributionManagerImpl

java.lang.Object

org.infinispan.distribution.DistributionManagerImpl

All Implemented Interfaces:

DistributionManager

public class DistributionManagerImpl
extends Object
implements DistributionManager

The default distribution manager implementation

Since:

4.0

Author:

Manik Surtani, Vladimir Blagojevic, Mircea.Markus@jboss.com, Bela Ban, Dan Berindei

Constructor Summary

Constructors

Constructor and Description
DistributionManagerImpl() Default constructor

Method Summary

Methods

Modifier and Type	Method and Description
Collection<Address>	getAffectedNodes(Collection<Object> affectedKeys) A helper method that retrieves a list of nodes affected by operations on a set of keys.
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.
void	init(Configuration configuration, RpcManager rpcManager, CommandsFactory cf, CacheNotifier cacheNotifier, StateTransferManager stateTransferManager)
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	isLocal(Object key) Deprecated.
boolean	isLocatedLocally(String key)
boolean	isRehashInProgress() Tests whether a rehash is in progress
List<Address>	locate(Object key) Locates a key in a cluster.
Map<Object,List<Address>>	locateAll(Collection<Object> keys) Locates a list of keys in a cluster.
Map<Object,List<Address>>	locateAll(Collection<Object> keys, int numOwners) Same as DistributionManager.locateAll(java.util.Collection), but the list of addresses only contains numOwners owners.
List<String>	locateKey(String key)
InternalCacheEntry	retrieveFromRemoteSource(Object key, InvocationContext ctx, boolean acquireRemoteLock) Retrieves a cache entry from a remote source.
ConsistentHash	setConsistentHash(ConsistentHash newCH) Sets the consistent hash implementation in use.
String	toString()
void	transformForL1(CacheEntry entry) Transforms a cache entry so it is marked for L1 rather than the primary cache data structure.

Methods inherited from class java.lang.Object

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

Constructor Detail

DistributionManagerImpl

public DistributionManagerImpl()

Default constructor

Method Detail

init

public void init(Configuration configuration,
        RpcManager rpcManager,
        CommandsFactory cf,
        CacheNotifier cacheNotifier,
        StateTransferManager stateTransferManager)

isLocal

@Deprecated
public boolean isLocal(Object key)

Deprecated.

Description copied from interface: DistributionManager

Checks whether a key is mapped to the local node.

Do not use! This API is buggy in that it doesn't take into account changing ownerships and can introduce race conditions if results are relied upon. Please use DistributionManager.getLocality(Object) instead.

Specified by:

isLocal in interface DistributionManager

Parameters:

key - key to test

Returns:

true if local, false otherwise.

getLocality

public DataLocality getLocality(Object key)

Description copied from interface: DistributionManager

Returns the data locality characteristics of a given key.

Specified by:

getLocality in interface DistributionManager

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

public List<Address> locate(Object key)

Description copied from interface: DistributionManager

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.

Specified by:

locate in interface DistributionManager

Parameters:

key - key to test

Returns:

a list of addresses where the key may reside

getPrimaryLocation

public Address getPrimaryLocation(Object key)

Description copied from interface: DistributionManager

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

Specified by:

getPrimaryLocation in interface DistributionManager

Parameters:

key - key to test

Returns:

the first address on which the key may reside

locateAll

public Map<Object,List<Address>> locateAll(Collection<Object> keys)

Description copied from interface: DistributionManager

Locates a list of keys in a cluster. Like DistributionManager.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.

Specified by:

locateAll in interface DistributionManager

Parameters:

keys - list of keys to test

Returns:

a list of addresses where the key may reside

locateAll

public Map<Object,List<Address>> locateAll(Collection<Object> keys,
                                  int numOwners)

Description copied from interface: DistributionManager

Same as DistributionManager.locateAll(java.util.Collection), but the list of addresses only contains numOwners owners.

Specified by:

locateAll in interface DistributionManager

transformForL1

public void transformForL1(CacheEntry entry)

Description copied from interface: DistributionManager

Transforms a cache entry so it is marked for L1 rather than the primary cache data structure. This should be done if it is deemed that the entry is targeted for L1 storage rather than storage in the primary data container.

Specified by:

transformForL1 in interface DistributionManager

Parameters:

entry - entry to transform

retrieveFromRemoteSource

public InternalCacheEntry retrieveFromRemoteSource(Object key,
                                          InvocationContext ctx,
                                          boolean acquireRemoteLock)
                                            throws Exception

Description copied from interface: DistributionManager

Retrieves a cache entry from a remote source. Would typically involve an RPC call using a ClusteredGetCommand and some form of quorum of responses if the responses returned are inconsistent - often the case if there is a rehash in progress, involving nodes that the key maps to.

Specified by:

retrieveFromRemoteSource in interface DistributionManager

Parameters:

key - key to look up

Returns:

an internal cache entry, or null if it cannot be located

Throws:

Exception

getConsistentHash

public ConsistentHash getConsistentHash()

Description copied from interface: DistributionManager

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

Specified by:

getConsistentHash in interface DistributionManager

Returns:

a ConsistentHash instance

setConsistentHash

public ConsistentHash setConsistentHash(ConsistentHash newCH)

Description copied from interface: DistributionManager

Sets the consistent hash implementation in use.

Specified by:

setConsistentHash in interface DistributionManager

Parameters:

newCH - consistent hash to set to

Returns:

previous consistent hash, the last one for which rehash completed

isAffectedByRehash

public boolean isAffectedByRehash(Object key)

Description copied from interface: DistributionManager

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.

Specified by:

isAffectedByRehash in interface DistributionManager

Parameters:

key - key to test

Returns:

whether a key is affected by a rehash

isRehashInProgress

public boolean isRehashInProgress()

Tests whether a rehash is in progress

Specified by:

isRehashInProgress in interface DistributionManager

Returns:

true if a rehash is in progress, false otherwise

isJoinComplete

public boolean isJoinComplete()

Description copied from interface: DistributionManager

Tests whether the current instance has completed joining the cluster

Specified by:

isJoinComplete in interface DistributionManager

Returns:

true if join is in progress, false otherwise

getAffectedNodes

public Collection<Address> getAffectedNodes(Collection<Object> affectedKeys)

Description copied from interface: DistributionManager

A helper method that retrieves a list of nodes affected by operations on a set of keys. This helper will in turn call DistributionManager.locateAll(java.util.Collection) and then combine the result addresses.

Specified by:

getAffectedNodes in interface DistributionManager

Parameters:

affectedKeys - keys to locate

Returns:

a list of addresses which represent a combined set of all addresses affected by the set of keys.

isLocatedLocally

public boolean isLocatedLocally(String key)

locateKey

public List<String> locateKey(String key)

toString

public String toString()

Overrides:

toString in class Object