com.gigaspaces.internal.cluster.node

Interface IReplicationNode

All Known Implementing Classes:

ReplicationNode

public interface IReplicationNode

The interaction point between a single space instance and a cluster of spaces

Since:

8.0

Author:

eitany

Method Summary

Modifier and Type	Method and Description
void	close() Closes the node, once closed the node is no longer usable.
IReplicationOutContext	createContext()
int	execute(IReplicationOutContext replicationContext) Executes the accumulated replication according to the given context
IReplicationNodeAdmin	getAdmin()
BlobStoreReplicaConsumeHelper	getBlobStoreReplicaConsumeHelper()
BlobStoreReplicationBulkConsumeHelper	getBlobStoreReplicationBulkConsumeHelper()
DirectPersistencyBackupSyncIteratorHandler	getDirectPersistencyBackupSyncIteratorHandler()
IDirectPersistencySyncHandler	getDirectPesistencySyncHandler()
void	outCancelEntryLease(IReplicationOutContext context, IEntryHolder entryHolder) Notify replication node that an entry lease was canceled
void	outChangeEntry(IReplicationOutContext context, IEntryHolder entryHolder) Notify replication node that an entry was changed
void	outDataTypeAddIndex(IReplicationOutContext context, AddTypeIndexesRequestInfo addIndexesRequest) Notify the replication node that new index was added to this data type
void	outDataTypeIntroduce(IReplicationOutContext context, ITypeDesc typeDescriptor) Notify the replication node that new data type was introduced
void	outEntryLeaseExpired(IReplicationOutContext context, IEntryHolder entryHolder) Notify replication node that an entry lease expired
void	outEvictEntry(IReplicationOutContext context, IEntryHolder entryHolder) Notify replication node that an entry was evicted
void	outExtendEntryLeasePeriod(IReplicationOutContext context, IEntryHolder entryHolder) Notify replication node that an entry lease is extended
void	outExtendNotifyTemplateLeasePeriod(IReplicationOutContext context, NotifyTemplateHolder entryHolder) Notify replication node that a notify template lease is extended
void	outInsertNotifyTemplate(IReplicationOutContext context, NotifyTemplateHolder templateHolder) Notify replication node that a new notify template was inserted
void	outNotificationSentAndExecute(OperationID operationId) Notify and dispatch the replication event representing that a notification was sent successfully
void	outNotifyTemplateLeaseExpired(IReplicationOutContext context, NotifyTemplateHolder templateHolder) Notify replication node that an notify template lease expired
void	outRemoveEntry(IReplicationOutContext context, IEntryHolder entryHolder) Notify replication node that an entry was removed
void	outRemoveNotifyTemplate(IReplicationOutContext context, NotifyTemplateHolder templateHolder) Notify replication node that a notify template was removed
void	outTransaction(IReplicationOutContext context, ServerTransaction transaction, ArrayList<IEntryHolder> lockedEntries) Notify replication node that a transaction is executed in one stage (one phase commit)
void	outTransactionAbort(IReplicationOutContext context, ServerTransaction transaction) Notify replication node that a transaction abort is executed (two phase commit)
void	outTransactionCommit(IReplicationOutContext context, ServerTransaction transaction) Notify replication node that a transaction commit is executed (two phase commit)
void	outTransactionPrepare(IReplicationOutContext context, ServerTransaction transaction, ArrayList<IEntryHolder> lockedEntries) Notify replication node that a transaction prepare is executed (two phase commit)
void	outUpdateEntry(IReplicationOutContext context, IEntryHolder entryHolder) Notify replication node that an entry was updated
void	outWriteEntry(IReplicationOutContext context, IEntryHolder entryHolder) Notify replication node that a new entry was written
void	rollbackCopyReplica(ISpaceCopyResult replicaResult)
void	setBlobStoreReplicaConsumeHelper(BlobStoreReplicaConsumeHelper blobStoreReplicaHelper)
void	setBlobStoreReplicationBulkConsumeHelper(BlobStoreReplicationBulkConsumeHelper blobStoreReplicationBulkConsumeHelper)
void	setDirectPersistencyBackupSyncIteratorHandler(DirectPersistencyBackupSyncIteratorHandler directPersistencyBackupSyncIteratorHandler)
void	setInBatchConsumptionHandler(IReplicationInBatchConsumptionHandler handler) Sets a handler for incoming replication upon batch consumption completion
void	setInDataTypeCreatedHandler(IReplicationInDataTypeCreatedHandler handler) Sets a handler for incoming data type replication event which was generated by a different node as a result of outDataTypeIntroduce(IReplicationOutContext, ITypeDesc)
void	setInDataTypeIndexAddedHandler(IReplicationInDataTypeIndexAddedHandler handler) Sets a handler for incoming data type add index replication event which was generated by a different node as a result of outDataTypeIntroduce(IReplicationOutContext, ITypeDesc)
void	setInEntryHandler(IReplicationInEntryHandler handler) Sets a handler for incoming write entry replication event which was generated by a different node as a result of outWriteEntry(IReplicationOutContext, IEntryHolder)
void	setInEntryLeaseCancelledHandler(IReplicationInEntryLeaseCancelledHandler handler) Sets a handler for incoming cancel entry lease replication event which was generated by a different node as a result of outCancelEntryLease(IReplicationOutContext, IEntryHolder)
void	setInEntryLeaseExpiredHandler(IReplicationInEntryLeaseExpiredHandler handler) Sets a handler for incoming entry lease expired replication event which was generated by a different node as a result of outCancelEntryLease(IReplicationOutContext, IEntryHolder)
void	setInEntryLeaseExtendedHandler(IReplicationInEntryLeaseExtendedHandler handler) Sets a handler for incoming extend lease replication event which was generated by a different node as a result of outExtendEntryLeasePeriod(IReplicationOutContext, IEntryHolder)
void	setInEvictEntryHandler(IReplicationInEvictEntryHandler handler) Sets a handler for incoming evict entry replication event which was generated by a different node as a result of outEvictEntry(IReplicationOutContext, IEntryHolder)
void	setInNotificationSentHandler(IReplicationInNotificationSentHandler handler) Sets a handler for incoming notification sent event which was generated by a different node as a result of outNotificationSentAndExecute(OperationID)
void	setInNotifyTemplateCreatedHandler(IReplicationInNotifyTemplateCreatedHandler handler) Sets a handler for incoming insert notify template replication event which was generated by a different node as a result of outInsertNotifyTemplate(IReplicationOutContext, NotifyTemplateHolder)
void	setInNotifyTemplateLeaseExpiredHandler(IReplicationInNotifyTemplateLeaseExpiredHandler handler) Sets a handler for incoming notify-template lease expired replication event which was generated by a different node as a result of outNotifyTemplateLeaseExpired(IReplicationOutContext, NotifyTemplateHolder)
void	setInNotifyTemplateLeaseExtendedHandler(IReplicationInNotifyTemplateLeaseExtendedHandler handler) Sets a handler for incoming extend lease replication event which was generated by a different node as a result of #outExtendNotifyTemplateLeasePeriod(IReplicationOutContext, IEntryHolder)
void	setInNotifyTemplateRemovedHandler(IReplicationInNotifyTemplateRemovedHandler handler) Sets a handler for incoming remove notify template replication event which was generated by a different node as a result of outRemoveNotifyTemplate(IReplicationOutContext, NotifyTemplateHolder)
void	setInTransactionHandler(IReplicationInTransactionHandler handler) Sets a handler for incoming transaction replication event which was generated by a different node as a result of #outTransaction(IReplicationOutContext, ServerTransaction, ArrayList)
ISpaceCopyReplicaState	spaceCopyReplicaRequest(ISpaceCopyReplicaRequestContext context) Starts a space copy replica request, will copy the current state of a remote space.
ISpaceSynchronizeReplicaState	spaceSynchronizeReplicaRequest(ISpaceSynchronizeReplicaRequestContext context) Starts a space synchronize replica request, will copy the current state of a remote space and synchronize with ongoing changes, the synchronization can only occurr if the target space has replication channel to this space (Recovery).

Method Detail

outWriteEntry

void outWriteEntry(IReplicationOutContext context,
                   IEntryHolder entryHolder)

Notify replication node that a new entry was written

Parameters:

context - the context of the operation

entryHolder - written entry

setInEntryHandler

void setInEntryHandler(IReplicationInEntryHandler handler)

Sets a handler for incoming write entry replication event which was generated by a different node as a result of outWriteEntry(IReplicationOutContext, IEntryHolder)

outUpdateEntry

void outUpdateEntry(IReplicationOutContext context,
                    IEntryHolder entryHolder)

Notify replication node that an entry was updated

Parameters:

context - the context of the operation

entryHolder - updated entry

outChangeEntry

void outChangeEntry(IReplicationOutContext context,
                    IEntryHolder entryHolder)

Notify replication node that an entry was changed

Parameters:

context - the context of the operation

entryHolder - mutated entry

Since:

9.1

outRemoveEntry

void outRemoveEntry(IReplicationOutContext context,
                    IEntryHolder entryHolder)

Notify replication node that an entry was removed

Parameters:

context - the context of the operation

entryHolder - removed entry

outCancelEntryLease

void outCancelEntryLease(IReplicationOutContext context,
                         IEntryHolder entryHolder)

Notify replication node that an entry lease was canceled

Parameters:

context - the context of the operation

entryHolder - entry of which its lease was canceled

outEntryLeaseExpired

void outEntryLeaseExpired(IReplicationOutContext context,
                          IEntryHolder entryHolder)

Notify replication node that an entry lease expired

Parameters:

context - the context of the operation

entryHolder - entry of which its lease expired

setInEntryLeaseCancelledHandler

void setInEntryLeaseCancelledHandler(IReplicationInEntryLeaseCancelledHandler handler)

Sets a handler for incoming cancel entry lease replication event which was generated by a different node as a result of outCancelEntryLease(IReplicationOutContext, IEntryHolder)

setInEntryLeaseExpiredHandler

void setInEntryLeaseExpiredHandler(IReplicationInEntryLeaseExpiredHandler handler)

Sets a handler for incoming entry lease expired replication event which was generated by a different node as a result of outCancelEntryLease(IReplicationOutContext, IEntryHolder)

outEvictEntry

void outEvictEntry(IReplicationOutContext context,
                   IEntryHolder entryHolder)

Notify replication node that an entry was evicted

Parameters:

context - the context of the operation

entryHolder - evicted entry

setInEvictEntryHandler

void setInEvictEntryHandler(IReplicationInEvictEntryHandler handler)

Sets a handler for incoming evict entry replication event which was generated by a different node as a result of outEvictEntry(IReplicationOutContext, IEntryHolder)

outInsertNotifyTemplate

void outInsertNotifyTemplate(IReplicationOutContext context,
                             NotifyTemplateHolder templateHolder)

Notify replication node that a new notify template was inserted

Parameters:

context - the context of the operation

templateHolder - inserted template

setInNotifyTemplateCreatedHandler

void setInNotifyTemplateCreatedHandler(IReplicationInNotifyTemplateCreatedHandler handler)

Sets a handler for incoming insert notify template replication event which was generated by a different node as a result of outInsertNotifyTemplate(IReplicationOutContext, NotifyTemplateHolder)

outRemoveNotifyTemplate

void outRemoveNotifyTemplate(IReplicationOutContext context,
                             NotifyTemplateHolder templateHolder)

Notify replication node that a notify template was removed

Parameters:

context - the context of the operation

templateHolder - removed template

setInNotifyTemplateRemovedHandler

void setInNotifyTemplateRemovedHandler(IReplicationInNotifyTemplateRemovedHandler handler)

Sets a handler for incoming remove notify template replication event which was generated by a different node as a result of outRemoveNotifyTemplate(IReplicationOutContext, NotifyTemplateHolder)

outNotifyTemplateLeaseExpired

void outNotifyTemplateLeaseExpired(IReplicationOutContext context,
                                   NotifyTemplateHolder templateHolder)

Notify replication node that an notify template lease expired

Parameters:

context - the context of the operation

templateHolder - of which its lease expired

setInNotifyTemplateLeaseExpiredHandler

void setInNotifyTemplateLeaseExpiredHandler(IReplicationInNotifyTemplateLeaseExpiredHandler handler)

Sets a handler for incoming notify-template lease expired replication event which was generated by a different node as a result of outNotifyTemplateLeaseExpired(IReplicationOutContext, NotifyTemplateHolder)

outExtendEntryLeasePeriod

void outExtendEntryLeasePeriod(IReplicationOutContext context,
                               IEntryHolder entryHolder)

Notify replication node that an entry lease is extended

Parameters:

context - the context of the operation

setInNotifyTemplateLeaseExtendedHandler

void setInNotifyTemplateLeaseExtendedHandler(IReplicationInNotifyTemplateLeaseExtendedHandler handler)

Sets a handler for incoming extend lease replication event which was generated by a different node as a result of #outExtendNotifyTemplateLeasePeriod(IReplicationOutContext, IEntryHolder)

outExtendNotifyTemplateLeasePeriod

void outExtendNotifyTemplateLeasePeriod(IReplicationOutContext context,
                                        NotifyTemplateHolder entryHolder)

Notify replication node that a notify template lease is extended

Parameters:

context - the context of the operation

setInEntryLeaseExtendedHandler

void setInEntryLeaseExtendedHandler(IReplicationInEntryLeaseExtendedHandler handler)

Sets a handler for incoming extend lease replication event which was generated by a different node as a result of outExtendEntryLeasePeriod(IReplicationOutContext, IEntryHolder)

outTransaction

void outTransaction(IReplicationOutContext context,
                    ServerTransaction transaction,
                    ArrayList<IEntryHolder> lockedEntries)

Notify replication node that a transaction is executed in one stage (one phase commit)

Parameters:

transaction - executed transaction

lockedEntries - entries participating in the transaction and their corresponding operation

outTransactionPrepare

void outTransactionPrepare(IReplicationOutContext context,
                           ServerTransaction transaction,
                           ArrayList<IEntryHolder> lockedEntries)

Notify replication node that a transaction prepare is executed (two phase commit)

Parameters:

transaction - prepared transaction

lockedEntries - entries participating in the transaction and their corresponding operation

outTransactionCommit

void outTransactionCommit(IReplicationOutContext context,
                          ServerTransaction transaction)

Notify replication node that a transaction commit is executed (two phase commit)

Parameters:

transaction - committed transaction

outTransactionAbort

void outTransactionAbort(IReplicationOutContext context,
                         ServerTransaction transaction)

Notify replication node that a transaction abort is executed (two phase commit)

Parameters:

transaction - committed transaction

setInTransactionHandler

void setInTransactionHandler(IReplicationInTransactionHandler handler)

Sets a handler for incoming transaction replication event which was generated by a different node as a result of #outTransaction(IReplicationOutContext, ServerTransaction, ArrayList)

outNotificationSentAndExecute

void outNotificationSentAndExecute(OperationID operationId)

Notify and dispatch the replication event representing that a notification was sent successfully

Parameters:

OperationID - the operation Id of the event

outDataTypeIntroduce

void outDataTypeIntroduce(IReplicationOutContext context,
                          ITypeDesc typeDescriptor)

Notify the replication node that new data type was introduced

Parameters:

typeDescriptor - the updated type descriptor

outDataTypeAddIndex

void outDataTypeAddIndex(IReplicationOutContext context,
                         AddTypeIndexesRequestInfo addIndexesRequest)

Notify the replication node that new index was added to this data type

setInDataTypeCreatedHandler

void setInDataTypeCreatedHandler(IReplicationInDataTypeCreatedHandler handler)

Sets a handler for incoming data type replication event which was generated by a different node as a result of outDataTypeIntroduce(IReplicationOutContext, ITypeDesc)

setInDataTypeIndexAddedHandler

void setInDataTypeIndexAddedHandler(IReplicationInDataTypeIndexAddedHandler handler)

Sets a handler for incoming data type add index replication event which was generated by a different node as a result of outDataTypeIntroduce(IReplicationOutContext, ITypeDesc)

setInNotificationSentHandler

void setInNotificationSentHandler(IReplicationInNotificationSentHandler handler)

Sets a handler for incoming notification sent event which was generated by a different node as a result of outNotificationSentAndExecute(OperationID)

setInBatchConsumptionHandler

void setInBatchConsumptionHandler(IReplicationInBatchConsumptionHandler handler)

Sets a handler for incoming replication upon batch consumption completion

createContext

IReplicationOutContext createContext()

Returns:

create a replication out context

execute

int execute(IReplicationOutContext replicationContext)

Executes the accumulated replication according to the given context

Parameters:

replicationContext - replication context

Returns:

true number of completed replications.

getAdmin

IReplicationNodeAdmin getAdmin()

Returns:

administrator of the replication node

spaceSynchronizeReplicaRequest

ISpaceSynchronizeReplicaState spaceSynchronizeReplicaRequest(ISpaceSynchronizeReplicaRequestContext context)

Starts a space synchronize replica request, will copy the current state of a remote space and synchronize with ongoing changes, the synchronization can only occurr if the target space has replication channel to this space (Recovery).

Returns:

space synchronize replica state representing the current progress of the synchronization

spaceCopyReplicaRequest

ISpaceCopyReplicaState spaceCopyReplicaRequest(ISpaceCopyReplicaRequestContext context)

Starts a space copy replica request, will copy the current state of a remote space. Should be used when the target space is in a static state, meaning its data state do not change during the copy, otherwise the copy result is not guaranteed to be an exact replica of the target space (Offline copy, for admin purposes).

Returns:

space copy replica state representing the current progress of the copy operation

rollbackCopyReplica

void rollbackCopyReplica(ISpaceCopyResult replicaResult)

setBlobStoreReplicaConsumeHelper

void setBlobStoreReplicaConsumeHelper(BlobStoreReplicaConsumeHelper blobStoreReplicaHelper)

getBlobStoreReplicaConsumeHelper

BlobStoreReplicaConsumeHelper getBlobStoreReplicaConsumeHelper()

getDirectPesistencySyncHandler

IDirectPersistencySyncHandler getDirectPesistencySyncHandler()

getDirectPersistencyBackupSyncIteratorHandler

DirectPersistencyBackupSyncIteratorHandler getDirectPersistencyBackupSyncIteratorHandler()

setDirectPersistencyBackupSyncIteratorHandler

void setDirectPersistencyBackupSyncIteratorHandler(DirectPersistencyBackupSyncIteratorHandler directPersistencyBackupSyncIteratorHandler)

close

void close()

Closes the node, once closed the node is no longer usable.

setBlobStoreReplicationBulkConsumeHelper

void setBlobStoreReplicationBulkConsumeHelper(BlobStoreReplicationBulkConsumeHelper blobStoreReplicationBulkConsumeHelper)

getBlobStoreReplicationBulkConsumeHelper

BlobStoreReplicationBulkConsumeHelper getBlobStoreReplicationBulkConsumeHelper()