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

Nested Class Summary

class

DistributionManagerImpl.ViewChangeListener

Constructor Summary

DistributionManagerImpl()
Default constructor

Method Summary

void	applyRemoteTxLog(List<WriteCommand> commands) Applies an ordered list of modifications to the current node.
void	applyState(ConsistentHash consistentHash, Map<Object,InternalCacheValue> state, Address sender, int viewId)
Collection<Address>	getAffectedNodes(Collection<Object> affectedKeys) A helper method that retrieves a list of nodes affected by operations on a set of keys.
CacheStore	getCacheStoreForRehashing() Retrieves a cache store if one is available and set up for use in rehashing.
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.
RpcManager	getRpcManager()
Address	getSelf()
TransactionLogger	getTransactionLogger() Retrieves the transaction logger instance associated with this DistributionManager
void	init(Configuration configuration, RpcManager rpcManager, CacheManagerNotifier notifier, CommandsFactory cf, DataContainer dataContainer, InterceptorChain interceptorChain, InvocationContextContainer icc, CacheLoaderManager cacheLoaderManager, InboundInvocationHandler inboundInvocationHandler, CacheNotifier cacheNotifier)
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)
void	markNodePushCompleted(int viewId, Address node)
void	markRehashCompleted(int viewId)
void	markRehashTaskCompleted()
void	notifyCoordinatorPushCompleted(int viewId)
InternalCacheEntry	retrieveFromRemoteSource(Object key, InvocationContext ctx) Retrieves a cache entry from a remote source.
void	setConfiguration(Configuration configuration)
ConsistentHash	setConsistentHash(ConsistentHash consistentHash) Sets the consistent hash implementation in use.
void	stop()
String	toString()
void	transformForL1(CacheEntry entry) Transforms a cache entry so it is marked for L1 rather than the primary cache data structure.
void	waitForJoinToComplete()
boolean	waitForRehashToComplete(int viewId) Wait until the cluster-wide rehash for view viewId has finished.

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,
                 CacheManagerNotifier notifier,
                 CommandsFactory cf,
                 DataContainer dataContainer,
                 InterceptorChain interceptorChain,
                 InvocationContextContainer icc,
                 CacheLoaderManager cacheLoaderManager,
                 InboundInvocationHandler inboundInvocationHandler,
                 CacheNotifier cacheNotifier)

getRpcManager

public RpcManager getRpcManager()

waitForJoinToComplete

public void waitForJoinToComplete()
                           throws InterruptedException

Specified by:

waitForJoinToComplete in interface DistributionManager

Throws:

InterruptedException

stop

public void stop()

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

waitForRehashToComplete

public boolean waitForRehashToComplete(int viewId)
                                throws InterruptedException,
                                       TimeoutException

Description copied from interface: DistributionManager

Wait until the cluster-wide rehash for view viewId has finished.

Specified by:

waitForRehashToComplete in interface DistributionManager

Returns:

true if the rehashed finished successfully, false if there is another rehash pending.

Throws:

InterruptedException

TimeoutException

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)
                                            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 - if something bad happens

getSelf

public Address getSelf()

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 consistentHash)

Description copied from interface: DistributionManager

Sets the consistent hash implementation in use.

Specified by:

setConsistentHash in interface DistributionManager

Parameters:

consistentHash - 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

getTransactionLogger

public TransactionLogger getTransactionLogger()

Description copied from interface: DistributionManager

Retrieves the transaction logger instance associated with this DistributionManager

Specified by:

getTransactionLogger in interface DistributionManager

Returns:

a TransactionLogger

applyState

public void applyState(ConsistentHash consistentHash,
                       Map<Object,InternalCacheValue> state,
                       Address sender,
                       int viewId)
                throws InterruptedException

Specified by:

applyState in interface DistributionManager

Throws:

InterruptedException

markRehashCompleted

public void markRehashCompleted(int viewId)
                         throws InterruptedException

Specified by:

markRehashCompleted in interface DistributionManager

Throws:

InterruptedException

markNodePushCompleted

public void markNodePushCompleted(int viewId,
                                  Address node)
                           throws InterruptedException

Specified by:

markNodePushCompleted in interface DistributionManager

Throws:

InterruptedException

notifyCoordinatorPushCompleted

public void notifyCoordinatorPushCompleted(int viewId)
                                    throws Exception

Specified by:

notifyCoordinatorPushCompleted in interface DistributionManager

Throws:

Exception

getCacheStoreForRehashing

public CacheStore getCacheStoreForRehashing()

Description copied from interface: DistributionManager

Retrieves a cache store if one is available and set up for use in rehashing. May return null!

Specified by:

getCacheStoreForRehashing in interface DistributionManager

Returns:

a cache store is one is available and configured for use in rehashing, or null otherwise.

isRehashInProgress

public boolean isRehashInProgress()

Description copied from interface: DistributionManager

Tests whether a rehash is in progress

Specified by:

isRehashInProgress in interface DistributionManager

Returns:

true if a rehash is in progress, false otherwise

markRehashTaskCompleted

public void markRehashTaskCompleted()

Specified by:

markRehashTaskCompleted in interface DistributionManager

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.

applyRemoteTxLog

public void applyRemoteTxLog(List<WriteCommand> commands)

Description copied from interface: DistributionManager

Applies an ordered list of modifications to the current node. Typically used when state is pushed to the node (i.e., anotehr node leaves the cluster) and the transaction log needs to be flushed after pushing state.

Specified by:

applyRemoteTxLog in interface DistributionManager

Parameters:

commands - ordered list of mods

isLocatedLocally

public boolean isLocatedLocally(String key)

locateKey

public List<String> locateKey(String key)

toString

public String toString()

Overrides:

toString in class Object

setConfiguration

public void setConfiguration(Configuration configuration)