Package org.infinispan.xsite

Class ClusteredCacheBackupReceiver

java.lang.Object

org.infinispan.xsite.ClusteredCacheBackupReceiver

All Implemented Interfaces:

BackupReceiver

public class ClusteredCacheBackupReceiver
extends Object
implements BackupReceiver

BackupReceiver implementation for clustered caches.

Since:

7.1

Author:

Pedro Ruivo

Constructor Summary

Constructors

Constructor	Description
ClusteredCacheBackupReceiver(String cacheName)

Method Summary

Modifier and Type	Method	Description
CompletionStage<Void>	clearKeys()	Clears the cache.
CompletionStage<Void>	handleEndReceivingStateTransfer(XSiteStateTransferFinishReceiveCommand command)	It handles finishing the state transfer from a remote site.
final <O> CompletionStage<O>	handleRemoteCommand(VisitableCommand command, boolean preserveOrder)
CompletionStage<Void>	handleStartReceivingStateTransfer(XSiteStateTransferStartReceiveCommand command)	It handles starting the state transfer from a remote site.
CompletionStage<Void>	handleStateTransferState(XSiteStatePushCommand cmd)	It handles the state transfer state from a remote site.
CompletionStage<Void>	putKeyValue(Object key, Object value, Metadata metadata, IracMetadata iracMetadata)	Updates the key with the value from a remote site.
CompletionStage<Void>	removeKey(Object key, IracMetadata iracMetadata, boolean expiration)	Deletes the key.
void	start()
CompletionStage<Boolean>	touchEntry(Object key)	Touches an entry and returns if it was able to or not.

Methods inherited from class java.lang.Object

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

Constructor Details

ClusteredCacheBackupReceiver

public ClusteredCacheBackupReceiver(String cacheName)

Method Details

start

public void start()

handleStartReceivingStateTransfer

public CompletionStage<Void> handleStartReceivingStateTransfer(XSiteStateTransferStartReceiveCommand command)

Description copied from interface: BackupReceiver

It handles starting the state transfer from a remote site. The command must be broadcast to the entire cluster in which the cache exists.

Specified by:

handleStartReceivingStateTransfer in interface BackupReceiver

handleEndReceivingStateTransfer

public CompletionStage<Void> handleEndReceivingStateTransfer(XSiteStateTransferFinishReceiveCommand command)

Description copied from interface: BackupReceiver

It handles finishing the state transfer from a remote site. The command must be broadcast to the entire cluster in which the cache exists.

Specified by:

handleEndReceivingStateTransfer in interface BackupReceiver

handleStateTransferState

public CompletionStage<Void> handleStateTransferState(XSiteStatePushCommand cmd)

Description copied from interface: BackupReceiver

It handles the state transfer state from a remote site. It is possible to have a single node applying the state or forward the state to respective primary owners.

Specified by:

handleStateTransferState in interface BackupReceiver

handleRemoteCommand

public final <O> CompletionStage<O> handleRemoteCommand(VisitableCommand command,
 boolean preserveOrder)

Specified by:

handleRemoteCommand in interface BackupReceiver

putKeyValue

public CompletionStage<Void> putKeyValue(Object key,
 Object value,
 Metadata metadata,
 IracMetadata iracMetadata)

Description copied from interface: BackupReceiver

Updates the key with the value from a remote site.

If a conflict occurs, the update can be discarded.

Specified by:

putKeyValue in interface BackupReceiver

Parameters:

key - The key to update.

value - The new value.

metadata - The new Metadata.

iracMetadata - The IracMetadata for conflict resolution.

Returns:

A CompletionStage that is completed when the update is apply in the cluster or is discarded.

removeKey

public CompletionStage<Void> removeKey(Object key,
 IracMetadata iracMetadata,
 boolean expiration)

Description copied from interface: BackupReceiver

Deletes the key.

This is a request from the remote site and the removal can be discarded if a conflict happens.

Specified by:

removeKey in interface BackupReceiver

Parameters:

key - The key to delete.

iracMetadata - The IracMetadata for conflict resolution.

expiration - true if it is to remove an expired key.

Returns:

A CompletionStage that is completed when the key is deleted or it is discarded.

clearKeys

public CompletionStage<Void> clearKeys()

Description copied from interface: BackupReceiver

Clears the cache.

This is not safe and it doesn't perform any conflict resolution.

Specified by:

clearKeys in interface BackupReceiver

Returns:

A CompletionStage that is completed when the cache is cleared.

touchEntry

public CompletionStage<Boolean> touchEntry(Object key)

Description copied from interface: BackupReceiver

Touches an entry and returns if it was able to or not.

Specified by:

touchEntry in interface BackupReceiver

Parameters:

key - the key of the entry to touch

Returns:

if the entry was touched