Package org.infinispan.util

Class AbstractControlledLocalTopologyManager

java.lang.Object

org.infinispan.util.AbstractControlledLocalTopologyManager

All Implemented Interfaces:

LocalTopologyManager

public abstract class AbstractControlledLocalTopologyManager
extends Object
implements LocalTopologyManager

Class to be extended to allow some control over the local topology manager when testing Infinispan.

Note: create before/after method lazily when need.

Since:

6.0

Author:

Pedro Ruivo

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractControlledLocalTopologyManager(LocalTopologyManager delegate)

Method Summary

Modifier and Type	Method	Description
protected void	beforeConfirmRebalancePhase(String cacheName, int topologyId, Throwable throwable)
protected void	beforeHandleRebalance(String cacheName, CacheTopology cacheTopology, int viewId)
protected void	beforeHandleTopologyUpdate(String cacheName, CacheTopology cacheTopology, int viewId)
void	cacheShutdown(String name)	Initiates a cluster-wide cache shutdown for the specified cache
void	confirmRebalancePhase(String cacheName, int topologyId, int rebalanceId, Throwable throwable)	Confirm that the local cache cacheName has finished receiving the new data for topology topologyId.
AvailabilityMode	getCacheAvailability(String cacheName)	Retrieves the availability state of a cache.
CacheTopology	getCacheTopology(String cacheName)
PersistentUUID	getPersistentUUID()	Returns the local UUID of this node.
RebalancingStatus	getRebalancingStatus(String cacheName)	Retrieve the rebalancing status for the specified cache
CacheTopology	getStableCacheTopology(String cacheName)
void	handleCacheShutdown(String cacheName)	Handles the local operations related to gracefully shutting down a cache
void	handleRebalance(String cacheName, CacheTopology cacheTopology, int viewId, Address sender)	Performs the state transfer.
void	handleStableTopologyUpdate(String cacheName, CacheTopology cacheTopology, Address sender, int viewId)	Update the stable cache topology.
ManagerStatusResponse	handleStatusRequest(int viewId)	Recovers the current topology information for all running caches and returns it to the coordinator.
void	handleTopologyUpdate(String cacheName, CacheTopology cacheTopology, AvailabilityMode availabilityMode, int viewId, Address sender)	Updates the current and/or pending consistent hash, without transferring any state.
boolean	isCacheRebalancingEnabled(String cacheName)	Checks whether rebalancing is enabled for the specified cache.
boolean	isRebalancingEnabled()	Checks whether rebalancing is enabled for the entire cluster.
boolean	isTotalOrderCache(String cacheName)	Checks if the cache defined by cacheName is using total order.
CacheTopology	join(String cacheName, CacheJoinInfo joinInfo, CacheTopologyHandler stm, PartitionHandlingManager phm)	Forwards the join request to the coordinator.
void	leave(String cacheName)	Forwards the leave request to the coordinator.
void	setCacheAvailability(String cacheName, AvailabilityMode availabilityMode)	Updates the availability state of a cache (for the entire cluster).
void	setCacheRebalancingEnabled(String cacheName, boolean enabled)	Enable or disable rebalancing for the specified cache.
void	setRebalancingEnabled(boolean enabled)	Enable or disable rebalancing in the entire cluster.
void	startDelegate()
void	stopDelegate()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractControlledLocalTopologyManager

protected AbstractControlledLocalTopologyManager(LocalTopologyManager delegate)

Method Detail

join

public final CacheTopology join(String cacheName,
                                CacheJoinInfo joinInfo,
                                CacheTopologyHandler stm,
                                PartitionHandlingManager phm)
                         throws Exception

Description copied from interface: LocalTopologyManager

Forwards the join request to the coordinator.

Specified by:

join in interface LocalTopologyManager

Returns:

The current consistent hash.

Throws:

Exception

leave

public final void leave(String cacheName)

Description copied from interface: LocalTopologyManager

Forwards the leave request to the coordinator.

Specified by:

leave in interface LocalTopologyManager

confirmRebalancePhase

public final void confirmRebalancePhase(String cacheName,
                                        int topologyId,
                                        int rebalanceId,
                                        Throwable throwable)

Description copied from interface: LocalTopologyManager

Confirm that the local cache cacheName has finished receiving the new data for topology topologyId.

The coordinator can change during the state transfer, so we make the rebalance RPC async and we send the response as a different command.

Specified by:

confirmRebalancePhase in interface LocalTopologyManager

Parameters:

cacheName - the name of the cache

topologyId - the current topology id of the node at the time the rebalance is completed. This must be >= than the one when rebalance starts.

throwable - null unless local rebalance ended because of an error.

handleStatusRequest

public final ManagerStatusResponse handleStatusRequest(int viewId)

Description copied from interface: LocalTopologyManager

Recovers the current topology information for all running caches and returns it to the coordinator.

Specified by:

handleStatusRequest in interface LocalTopologyManager

handleTopologyUpdate

public final void handleTopologyUpdate(String cacheName,
                                       CacheTopology cacheTopology,
                                       AvailabilityMode availabilityMode,
                                       int viewId,
                                       Address sender)
                                throws InterruptedException

Description copied from interface: LocalTopologyManager

Updates the current and/or pending consistent hash, without transferring any state.

Specified by:

handleTopologyUpdate in interface LocalTopologyManager

Throws:

InterruptedException

handleRebalance

public final void handleRebalance(String cacheName,
                                  CacheTopology cacheTopology,
                                  int viewId,
                                  Address sender)
                           throws InterruptedException

Description copied from interface: LocalTopologyManager

Performs the state transfer.

Specified by:

handleRebalance in interface LocalTopologyManager

Throws:

InterruptedException

getCacheTopology

public final CacheTopology getCacheTopology(String cacheName)

Specified by:

getCacheTopology in interface LocalTopologyManager

Returns:

the current topology for a cache.

handleStableTopologyUpdate

public void handleStableTopologyUpdate(String cacheName,
                                       CacheTopology cacheTopology,
                                       Address sender,
                                       int viewId)

Description copied from interface: LocalTopologyManager

Update the stable cache topology. Mostly needed for backup, so that a new coordinator can recover the stable topology of the cluster.

Specified by:

handleStableTopologyUpdate in interface LocalTopologyManager

getStableCacheTopology

public CacheTopology getStableCacheTopology(String cacheName)

Specified by:

getStableCacheTopology in interface LocalTopologyManager

Returns:

the last stable topology for a cache.

isRebalancingEnabled

public boolean isRebalancingEnabled()
                             throws Exception

Description copied from interface: LocalTopologyManager

Checks whether rebalancing is enabled for the entire cluster.

Specified by:

isRebalancingEnabled in interface LocalTopologyManager

Throws:

Exception

setRebalancingEnabled

public void setRebalancingEnabled(boolean enabled)
                           throws Exception

Description copied from interface: LocalTopologyManager

Enable or disable rebalancing in the entire cluster.

Specified by:

setRebalancingEnabled in interface LocalTopologyManager

Throws:

Exception

isCacheRebalancingEnabled

public boolean isCacheRebalancingEnabled(String cacheName)
                                  throws Exception

Description copied from interface: LocalTopologyManager

Checks whether rebalancing is enabled for the specified cache.

Specified by:

isCacheRebalancingEnabled in interface LocalTopologyManager

Throws:

Exception

setCacheRebalancingEnabled

public void setCacheRebalancingEnabled(String cacheName,
                                       boolean enabled)
                                throws Exception

Description copied from interface: LocalTopologyManager

Enable or disable rebalancing for the specified cache.

Specified by:

setCacheRebalancingEnabled in interface LocalTopologyManager

Throws:

Exception

getRebalancingStatus

public RebalancingStatus getRebalancingStatus(String cacheName)
                                       throws Exception

Description copied from interface: LocalTopologyManager

Retrieve the rebalancing status for the specified cache

Specified by:

getRebalancingStatus in interface LocalTopologyManager

Throws:

Exception

getCacheAvailability

public AvailabilityMode getCacheAvailability(String cacheName)

Description copied from interface: LocalTopologyManager

Retrieves the availability state of a cache.

Specified by:

getCacheAvailability in interface LocalTopologyManager

setCacheAvailability

public void setCacheAvailability(String cacheName,
                                 AvailabilityMode availabilityMode)
                          throws Exception

Description copied from interface: LocalTopologyManager

Updates the availability state of a cache (for the entire cluster).

Specified by:

setCacheAvailability in interface LocalTopologyManager

Throws:

Exception

startDelegate

public final void startDelegate()

stopDelegate

public final void stopDelegate()

isTotalOrderCache

public boolean isTotalOrderCache(String cacheName)

Description copied from interface: LocalTopologyManager

Checks if the cache defined by cacheName is using total order.

If this component is not running or the cacheName is not defined, it returns false.

Specified by:

isTotalOrderCache in interface LocalTopologyManager

Returns:

true if the cache is using the total order protocol, false otherwise.

beforeHandleTopologyUpdate

protected void beforeHandleTopologyUpdate(String cacheName,
                                          CacheTopology cacheTopology,
                                          int viewId)

beforeHandleRebalance

protected void beforeHandleRebalance(String cacheName,
                                     CacheTopology cacheTopology,
                                     int viewId)

beforeConfirmRebalancePhase

protected void beforeConfirmRebalancePhase(String cacheName,
                                           int topologyId,
                                           Throwable throwable)

getPersistentUUID

public PersistentUUID getPersistentUUID()

Description copied from interface: LocalTopologyManager

Returns the local UUID of this node. If global state persistence is enabled, this UUID will be saved and reused across restarts

Specified by:

getPersistentUUID in interface LocalTopologyManager

cacheShutdown

public void cacheShutdown(String name)
                   throws Exception

Description copied from interface: LocalTopologyManager

Initiates a cluster-wide cache shutdown for the specified cache

Specified by:

cacheShutdown in interface LocalTopologyManager

Throws:

Exception

handleCacheShutdown

public void handleCacheShutdown(String cacheName)

Description copied from interface: LocalTopologyManager

Handles the local operations related to gracefully shutting down a cache

Specified by:

handleCacheShutdown in interface LocalTopologyManager