Package org.opends.server.replication.server.changelog.file

Class ReplicaCursor

java.lang.Object

org.opends.server.replication.server.changelog.file.ReplicaCursor

All Implemented Interfaces:

Closeable, AutoCloseable, DBCursor<UpdateMsg>

public class ReplicaCursor
extends Object
implements DBCursor<UpdateMsg>

DBCursor over a replica returning UpdateMsgs.

It decorates an existing DBCursor on a replicaDB and can possibly return replica offline messages when the decorated DBCursor is exhausted and the offline CSN is newer than the last returned update CSN.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opends.server.replication.server.changelog.api.DBCursor

DBCursor.CursorOptions, DBCursor.KeyMatchingStrategy, DBCursor.PositionStrategy

Constructor Summary

Constructors

Constructor	Description
ReplicaCursor(DBCursor<UpdateMsg> cursor, CSN offlineCSN, ReplicaId replicaId, ReplicationDomainDB domainDB)	Creates a ReplicaCursor object with a cursor to decorate and an offlineCSN to return as part of a ReplicaOfflineMsg.

Method Summary

Modifier and Type	Method	Description
void	close()	Release the resources and locks used by this Iterator.
UpdateMsg	getRecord()	Getter for the current record.
ReplicaId	getReplicaId()	Returns the replica identifier that this cursor is associated to.
boolean	next()	Skip to the next record of the database.
void	setOfflineCSN(CSN offlineCSN)	Sets the offline CSN to be returned by this cursor.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ReplicaCursor

public ReplicaCursor(DBCursor<UpdateMsg> cursor,
                     CSN offlineCSN,
                     ReplicaId replicaId,
                     ReplicationDomainDB domainDB)

Creates a ReplicaCursor object with a cursor to decorate and an offlineCSN to return as part of a ReplicaOfflineMsg.

Parameters:

cursor - the non-null underlying cursor that needs to be exhausted before we return a ReplicaOfflineMsg

offlineCSN - the offline CSN from which to builder the ReplicaOfflineMsg to return

replicaId - the replica identifier

domainDB - the DB for the provided replication domain

Method Detail

setOfflineCSN

public void setOfflineCSN(CSN offlineCSN)

Sets the offline CSN to be returned by this cursor.

Parameters:

offlineCSN - The offline CSN to be returned by this cursor. If null, it will unset any previous offlineCSN and never return a ReplicaOfflineMsg

getRecord

public UpdateMsg getRecord()

Description copied from interface: DBCursor

Getter for the current record.

Specified by:

getRecord in interface DBCursor<UpdateMsg>

Returns:

The current record.

getReplicaId

public ReplicaId getReplicaId()

Returns the replica identifier that this cursor is associated to.

Returns:

the replica identifier that this cursor is associated to

next

public boolean next()
             throws ChangelogException

Description copied from interface: DBCursor

Skip to the next record of the database.

Specified by:

next in interface DBCursor<UpdateMsg>

Returns:

true if has next, false otherwise

Throws:

ChangelogException - When database exception raised.

close

public void close()

Description copied from interface: DBCursor

Release the resources and locks used by this Iterator. This method must be called when the iterator is no longer used. Failure to do it could cause DB deadlock.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface DBCursor<UpdateMsg>

toString

public String toString()

Overrides:

toString in class Object