Package org.infinispan.topology

Class LocalTopologyManagerImpl

java.lang.Object

org.infinispan.topology.LocalTopologyManagerImpl

All Implemented Interfaces:

GlobalStateProvider, LocalTopologyManager

@MBean(objectName="LocalTopologyManager",
       description="Controls the cache membership and state transfer")
public class LocalTopologyManagerImpl
extends Object
implements LocalTopologyManager, GlobalStateProvider

The LocalTopologyManager implementation.

Since:

5.2

Author:

Dan Berindei

Constructor Summary

Constructors

Constructor	Description
LocalTopologyManagerImpl()

Method Summary

Modifier and Type	Method	Description
void	assertTopologyStable(String cacheName)	Asserts the cache with the given name has a stable topology installed.
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.
CompletionStage<Object>	executeOnCoordinatorRetry(ReplicableCommand command, int viewId, long endNanos)
AvailabilityMode	getCacheAvailability(String cacheName)	Retrieves the availability state of a cache.
CacheTopology	getCacheTopology(String cacheName)
String	getClusterAvailability()
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)
CompletionStage<Void>	handleCacheShutdown(String cacheName)	Handles the local operations related to gracefully shutting down a cache
CompletionStage<Void>	handleRebalance(String cacheName, CacheTopology cacheTopology, int viewId, Address sender)	Performs the state transfer.
CompletionStage<Void>	handleStableTopologyUpdate(String cacheName, CacheTopology newStableTopology, Address sender, int viewId)	Update the stable cache topology.
CompletionStage<ManagerStatusResponse>	handleStatusRequest(int viewId)	Recovers the current topology information for all running caches and returns it to the coordinator.
CompletionStage<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.
CompletionStage<CacheTopology>	join(String cacheName, CacheJoinInfo joinInfo, CacheTopologyHandler stm, PartitionHandlingManager phm)	Forwards the join request to the coordinator.
void	leave(String cacheName, long timeout)	Forwards the leave request to the coordinator.
void	prepareForPersist(ScopedPersistentState state)	This method is invoked by the GlobalStateManager just before persisting the global state
void	prepareForRestore(ScopedPersistentState state)	This method is invoked by the GlobalStateManager after starting up to notify that global state has been restored.
void	preStart()
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.
CompletionStage<Void>	stableTopologyCompletion(String cacheName)	Returns a CompletionStage that completes when the cache with the name cacheName has a stable topology.
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Constructor Details

LocalTopologyManagerImpl

public LocalTopologyManagerImpl()

Method Details

preStart

public void preStart()

start

public void start()

stop

public void stop()

join

public CompletionStage<CacheTopology> join(String cacheName,
 CacheJoinInfo joinInfo,
 CacheTopologyHandler stm,
 PartitionHandlingManager phm)

Description copied from interface: LocalTopologyManager

Forwards the join request to the coordinator.

Specified by:

join in interface LocalTopologyManager

Returns:

The current consistent hash.

leave

public void leave(String cacheName,
 long timeout)

Description copied from interface: LocalTopologyManager

Forwards the leave request to the coordinator.

Specified by:

leave in interface LocalTopologyManager

confirmRebalancePhase

public 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.

rebalanceId - the id of the current rebalance

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

handleStatusRequest

public CompletionStage<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

Parameters:

viewId - The coordinator's view id

handleTopologyUpdate

public CompletionStage<Void> handleTopologyUpdate(String cacheName,
 CacheTopology cacheTopology,
 AvailabilityMode availabilityMode,
 int viewId,
 Address sender)

Description copied from interface: LocalTopologyManager

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

Specified by:

handleTopologyUpdate in interface LocalTopologyManager

handleStableTopologyUpdate

public CompletionStage<Void> handleStableTopologyUpdate(String cacheName,
 CacheTopology newStableTopology,
 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

handleRebalance

public CompletionStage<Void> handleRebalance(String cacheName,
 CacheTopology cacheTopology,
 int viewId,
 Address sender)

Description copied from interface: LocalTopologyManager

Performs the state transfer.

Specified by:

handleRebalance in interface LocalTopologyManager

getCacheTopology

public CacheTopology getCacheTopology(String cacheName)

Specified by:

getCacheTopology in interface LocalTopologyManager

Returns:

the current topology for a cache.

getStableCacheTopology

public CacheTopology getStableCacheTopology(String cacheName)

Specified by:

getStableCacheTopology in interface LocalTopologyManager

Returns:

the last stable topology for a cache.

isRebalancingEnabled

@ManagedAttribute(description="Rebalancing enabled",
                  displayName="Rebalancing enabled",
                  dataType=TRAIT,
                  writable=true)
public boolean isRebalancingEnabled()

Description copied from interface: LocalTopologyManager

Checks whether rebalancing is enabled for the entire cluster.

Specified by:

isRebalancingEnabled in interface LocalTopologyManager

setRebalancingEnabled

public void setRebalancingEnabled(boolean enabled)

Description copied from interface: LocalTopologyManager

Enable or disable rebalancing in the entire cluster.

Specified by:

setRebalancingEnabled in interface LocalTopologyManager

isCacheRebalancingEnabled

public boolean isCacheRebalancingEnabled(String cacheName)

Description copied from interface: LocalTopologyManager

Checks whether rebalancing is enabled for the specified cache.

Specified by:

isCacheRebalancingEnabled in interface LocalTopologyManager

executeOnCoordinatorRetry

public CompletionStage<Object> executeOnCoordinatorRetry(ReplicableCommand command,
 int viewId,
 long endNanos)

setCacheRebalancingEnabled

public void setCacheRebalancingEnabled(String cacheName,
 boolean enabled)

Description copied from interface: LocalTopologyManager

Enable or disable rebalancing for the specified cache.

Specified by:

setCacheRebalancingEnabled in interface LocalTopologyManager

getRebalancingStatus

public RebalancingStatus getRebalancingStatus(String cacheName)

Description copied from interface: LocalTopologyManager

Retrieve the rebalancing status for the specified cache

Specified by:

getRebalancingStatus in interface LocalTopologyManager

getClusterAvailability

@ManagedAttribute(description="Cluster availability",
                  displayName="Cluster availability",
                  dataType=TRAIT,
                  writable=false)
public String getClusterAvailability()

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)

Description copied from interface: LocalTopologyManager

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

Specified by:

setCacheAvailability in interface LocalTopologyManager

cacheShutdown

public void cacheShutdown(String name)

Description copied from interface: LocalTopologyManager

Initiates a cluster-wide cache shutdown for the specified cache

Specified by:

cacheShutdown in interface LocalTopologyManager

handleCacheShutdown

public CompletionStage<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

stableTopologyCompletion

public CompletionStage<Void> stableTopologyCompletion(String cacheName)

Description copied from interface: LocalTopologyManager

Returns a CompletionStage that completes when the cache with the name cacheName has a stable topology. Returns null if the cache does not exist.

Specified by:

stableTopologyCompletion in interface LocalTopologyManager

assertTopologyStable

public void assertTopologyStable(String cacheName)

Description copied from interface: LocalTopologyManager

Asserts the cache with the given name has a stable topology installed.

Specified by:

assertTopologyStable in interface LocalTopologyManager

Parameters:

cacheName - : The cache name to search.

prepareForPersist

public void prepareForPersist(ScopedPersistentState state)

Description copied from interface: GlobalStateProvider

This method is invoked by the GlobalStateManager just before persisting the global state

Specified by:

prepareForPersist in interface GlobalStateProvider

prepareForRestore

public void prepareForRestore(ScopedPersistentState state)

Description copied from interface: GlobalStateProvider

This method is invoked by the GlobalStateManager after starting up to notify that global state has been restored.

Specified by:

prepareForRestore in interface GlobalStateProvider

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