Package org.infinispan.xsite.statetransfer

Class NoOpXSiteStateTransferManager

java.lang.Object

org.infinispan.xsite.statetransfer.NoOpXSiteStateTransferManager

All Implemented Interfaces:

XSiteStateTransferManager

public class NoOpXSiteStateTransferManager
extends Object
implements XSiteStateTransferManager

A no-op implementation of XSiteStateTransferManager.

This instance is used when cross-site replication is disabled.

Since:

8.0

Author:

Pedro Ruivo

Field Summary

Fields inherited from interface org.infinispan.xsite.statetransfer.XSiteStateTransferManager

STATUS_CANCELED, STATUS_ERROR, STATUS_OK, STATUS_SENDING

Constructor Summary

Constructors

Constructor	Description
NoOpXSiteStateTransferManager()

Method Summary

Modifier and Type	Method	Description
void	becomeCoordinator(String siteName)	Makes this node the coordinator for the state transfer to the site name.
void	cancelPushState(String siteName)	It cancels a running state transfer.
void	cancelReceive(String siteName)	Sets the cluster to normal state.
void	clearClusterStatus()	Clears the completed state transfer status in all the cluster.
void	clearStatus()	Clears the completed state transfer status.
Map<String,StateTransferStatus>	getClusterStatus()
List<String>	getRunningStateTransfers()
String	getSendingSiteName()
XSiteStateConsumer	getStateConsumer()
XSiteStateProvider	getStateProvider()
Map<String,StateTransferStatus>	getStatus()
void	notifyStatePushFinished(String siteName, Address node, boolean statusOk)	It receives the notifications from local site when some node finishes pushing the state to the remote site.
void	onTopologyUpdated(CacheTopology cacheTopology, boolean stateTransferInProgress)	Notifies XSiteStateTransferManager that a new CacheTopology is installed and if the local cluster state transfer is in progress (or about to start)
boolean	setAutomaticStateTransfer(String site, XSiteStateTransferMode mode)	Sets the XSiteStateTransferMode to the remote site.
void	startAutomaticStateTransferTo(ByteString remoteSite, boolean ignoreStatus)	Starts the automatic cross-site state transfer if available and if required.
void	startPushState(String siteName)	It notifies all nodes from local site to start transfer the state to the remote site.
XSiteStateTransferMode	stateTransferMode(String site)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

NoOpXSiteStateTransferManager

public NoOpXSiteStateTransferManager()

Method Details

notifyStatePushFinished

public void notifyStatePushFinished(String siteName,
 Address node,
 boolean statusOk)

Description copied from interface: XSiteStateTransferManager

It receives the notifications from local site when some node finishes pushing the state to the remote site.

Specified by:

notifyStatePushFinished in interface XSiteStateTransferManager

Parameters:

siteName - the remote site name

node - the Address from the node that finishes.

statusOk - true if no error or exception occurred during the state transfer.

startPushState

public void startPushState(String siteName)

Description copied from interface: XSiteStateTransferManager

It notifies all nodes from local site to start transfer the state to the remote site.

Specified by:

startPushState in interface XSiteStateTransferManager

Parameters:

siteName - the remote site name

cancelPushState

public void cancelPushState(String siteName)

Description copied from interface: XSiteStateTransferManager

It cancels a running state transfer.

Specified by:

cancelPushState in interface XSiteStateTransferManager

Parameters:

siteName - the site name to where the state is being sent.

getRunningStateTransfers

public List<String> getRunningStateTransfers()

Specified by:

getRunningStateTransfers in interface XSiteStateTransferManager

Returns:

a list of site names in which this cache is pushing state.

getStatus

public Map<String,StateTransferStatus> getStatus()

Specified by:

getStatus in interface XSiteStateTransferManager

Returns:

the completed state transfer status for which this node is the coordinator.

clearStatus

public void clearStatus()

Description copied from interface: XSiteStateTransferManager

Clears the completed state transfer status.

Specified by:

clearStatus in interface XSiteStateTransferManager

getClusterStatus

public Map<String,StateTransferStatus> getClusterStatus()

Specified by:

getClusterStatus in interface XSiteStateTransferManager

Returns:

the completed state transfer status from all the coordinators in the cluster.

clearClusterStatus

public void clearClusterStatus()

Description copied from interface: XSiteStateTransferManager

Clears the completed state transfer status in all the cluster.

Specified by:

clearClusterStatus in interface XSiteStateTransferManager

getSendingSiteName

public String getSendingSiteName()

Specified by:

getSendingSiteName in interface XSiteStateTransferManager

Returns:

null if this node is not receiving state or the site name which is sending the state.

cancelReceive

public void cancelReceive(String siteName)

Description copied from interface: XSiteStateTransferManager

Sets the cluster to normal state.

The main use for this method is when the link between the sites is broken and the receiver site keeps it state transfer state forever.

Specified by:

cancelReceive in interface XSiteStateTransferManager

Parameters:

siteName - the site name which is sending the state.

becomeCoordinator

public void becomeCoordinator(String siteName)

Description copied from interface: XSiteStateTransferManager

Makes this node the coordinator for the state transfer to the site name.

This method is invoked when the coordinator dies and this node receives a late start state transfer request.

Specified by:

becomeCoordinator in interface XSiteStateTransferManager

Parameters:

siteName - the site name.

onTopologyUpdated

public void onTopologyUpdated(CacheTopology cacheTopology,
 boolean stateTransferInProgress)

Description copied from interface: XSiteStateTransferManager

Notifies XSiteStateTransferManager that a new CacheTopology is installed and if the local cluster state transfer is in progress (or about to start)

Specified by:

onTopologyUpdated in interface XSiteStateTransferManager

Parameters:

cacheTopology - The new CacheTopology.

stateTransferInProgress - true if the state transfer is in progress or starting.

getStateProvider

public XSiteStateProvider getStateProvider()

Specified by:

getStateProvider in interface XSiteStateTransferManager

Returns:

The XSiteStateProvider instance.

getStateConsumer

public XSiteStateConsumer getStateConsumer()

Specified by:

getStateConsumer in interface XSiteStateTransferManager

Returns:

The XSiteStateConsumer instance.

startAutomaticStateTransferTo

public void startAutomaticStateTransferTo(ByteString remoteSite,
 boolean ignoreStatus)

Description copied from interface: XSiteStateTransferManager

Starts the automatic cross-site state transfer if available and if required.

Specified by:

startAutomaticStateTransferTo in interface XSiteStateTransferManager

Parameters:

remoteSite - The remote site to send state to.

ignoreStatus - If true, it starts the state transfer based only on XSiteStateTransferMode.

stateTransferMode

public XSiteStateTransferMode stateTransferMode(String site)

Specified by:

stateTransferMode in interface XSiteStateTransferManager

Parameters:

site - The remote site.

Returns:

The XSiteStateTransferMode configured for the remote site.

setAutomaticStateTransfer

public boolean setAutomaticStateTransfer(String site,
 XSiteStateTransferMode mode)

Description copied from interface: XSiteStateTransferManager

Sets the XSiteStateTransferMode to the remote site.

If the configuration for the remote site does not support the XSiteStateTransferMode, then this method returns false.

Specified by:

setAutomaticStateTransfer in interface XSiteStateTransferManager

Parameters:

site - The remote site.

mode - The new XSiteStateTransferMode.

Returns:

false if the site does not support the corresponding XSiteStateTransferMode.

toString

public String toString()

Overrides:

toString in class Object