Interface XSiteStateTransferManager

    • Method Detail

      • notifyStatePushFinished

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

        void startPushState​(String siteName)
                     throws Throwable
        It notifies all nodes from local site to start transfer the state to the remote site.
        Parameters:
        siteName - the remote site name
        Throws:
        Throwable - If some unexpected behavior occurs.
      • cancelPushState

        void cancelPushState​(String siteName)
                      throws Throwable
        It cancels a running state transfer.
        Parameters:
        siteName - the site name to where the state is being sent.
        Throws:
        Throwable - if some exception occurs during the remote invocation with the local cluster or remote site.
      • getRunningStateTransfers

        List<String> getRunningStateTransfers()
        Returns:
        a list of site names in which this cache is pushing state.
      • getStatus

        Map<String,​StateTransferStatus> getStatus()
        Returns:
        the completed state transfer status for which this node is the coordinator.
      • clearStatus

        void clearStatus()
        Clears the completed state transfer status.
      • getClusterStatus

        Map<String,​StateTransferStatus> getClusterStatus()
        Returns:
        the completed state transfer status from all the coordinators in the cluster.
      • clearClusterStatus

        void clearClusterStatus()
        Clears the completed state transfer status in all the cluster.
      • getSendingSiteName

        String getSendingSiteName()
        Returns:
        null if this node is not receiving state or the site name which is sending the state.
      • cancelReceive

        void cancelReceive​(String siteName)
                    throws Exception
        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.

        Parameters:
        siteName - the site name which is sending the state.
        Throws:
        Exception - if some exception occurs during the remote invocation.
      • becomeCoordinator

        void becomeCoordinator​(String siteName)
        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.

        Parameters:
        siteName - the site name.
      • onTopologyUpdated

        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)
        Parameters:
        cacheTopology - The new CacheTopology.
        stateTransferInProgress - true if the state transfer is in progress or starting.
      • startAutomaticStateTransfer

        void startAutomaticStateTransfer​(Collection<String> sites)
        Starts cross-site state transfer for the remote sites, if required.
        Parameters:
        sites - The remote sites.