Uses of Class org.opends.server.replication.common.CSN (OpenDJ Public API Javadoc 7.3.5-20240506155118-fba46f79e3510f00d8e7e5228e53672e49833f71 Documentation)

Packages that use CSN
Package	Description
org.opends.server.controls	Contains classes that represent specific LDAP controls and their values.
org.opends.server.plugins	Contains the implementation for various Directory Server plugins.
org.opends.server.replication.common	This package contains utilities that can are used by all the packages below org.opends.server.replication.
org.opends.server.replication.plugin	This package contains the part of the Multi-master replication code that works on the Directory Server side.
org.opends.server.replication.protocol	This package contains the code used by the replication server and by the code running on the Directory Server side to exchange their information.
org.opends.server.replication.server.changelog.api	This package contains the API for the changelog database.
org.opends.server.replication.server.changelog.file	This package contains a file-based log implementation for the changelog database API.
org.opends.server.replication.service	This package contains the generic of the Multi-Master replication code that works on the Directory Server side.
org.opends.server.tasks	Contains implementations for various Directory Server tasks.

Uses of CSN in org.opends.server.controls

Methods in org.opends.server.controls that return CSN
Modifier and Type	Method	Description
`CSN`	ReplicatedRequestControl.`getCSN()`	Returns the CSN.

Constructors in org.opends.server.controls with parameters of type CSN
Constructor	Description
`ReplicatedRequestControl(boolean isCritical, CSN csn, UUID entryUuid)`	Constructs a new control.
`ReplicatedRequestControl(boolean isCritical, CSN csn, UUID entryUuid, UUID parentUuid)`	Constructs a new control.

Uses of CSN in org.opends.server.plugins

Methods in org.opends.server.plugins that return CSN
Modifier and Type	Method	Description
`CSN`	ChangeNumberControlPlugin.ChangeNumberResponseControl.`getCSN()`	Retrieves the CSN.

Constructors in org.opends.server.plugins with parameters of type CSN
Constructor	Description
`ChangeNumberResponseControl(boolean isCritical, CSN csn)`	Constructs a new change number control.

Uses of CSN in org.opends.server.replication.common

Fields in org.opends.server.replication.common declared as CSN
Modifier and Type	Field	Description
`static CSN`	CSN.`MAX_VALUE`	The maximum possible value for a CSN.
`static CSN`	CSN.`MIN_VALUE`	The minimum possible value for a CSN.

Methods in org.opends.server.replication.common that return CSN
Modifier and Type	Method	Description
`CSN`	MultiDomainServerState.`getCSN(Dn baseDN, ReplicaId replicaId)`	Returns the CSN associated to the provided replication domain's baseDN and replicaId.
`CSN`	ServerState.`getCSN(ReplicaId replicaId)`	Returns the `CSN` contained in this server state which corresponds to the provided replica ID.
`CSN`	CSNGenerator.`newCSN()`	Generate a new `CSN`.
`static CSN`	CSN.`newestCsn(long timeStamp)`	Return the newest possible CSN for the given time.
`static CSN`	CSN.`newestCsn(ReplicaId replicaId)`	Returns the newest possible CSN for a replica.
`static CSN`	CSN.`oldestCsn(long timeStamp)`	Returns the oldest possible CSN for the given time.
`static CSN`	CSN.`oldestCsn(ReplicaId replicaId)`	Returns the oldest possible CSN for a replica.
`static CSN`	CSN.`valueOf(String str)`	Parses the provided `toString()` representation of a CSN.
`static CSN`	CSN.`valueOf(ByteSequence bs)`	Decodes the provided `toByteString(CsnVersion)` representation of a CSN.
`static CSN`	CSN.`valueOf(ByteSequenceReader reader)`	Decodes the provided `toByteString(CsnVersion)` representation of a CSN, possibly embedded in a larger sequence.

Methods in org.opends.server.replication.common that return types with arguments of type CSN
Modifier and Type	Method	Description
`Map<ReplicaId,CSN>`	ServerState.`getReplicaIdToCSNMap()`	Returns a copy of this ServerState's content as a Map of replicaId to CSN.
`Map<Dn,Set<CSN>>`	MultiDomainServerState.`getSnapshot()`	Returns a snapshot of this object.
`Set<CSN>`	ServerState.`getSnapshot()`	Returns a snapshot of this object.
`Iterator<CSN>`	ServerState.`iterator()`

Methods in org.opends.server.replication.common with parameters of type CSN
Modifier and Type	Method	Description
`void`	CSNGenerator.`adjust(CSN csn)`	Adjust the lastTime of this `CSNGenerator` with a `CSN` that we have received from another server.
`static int`	CSN.`compare(CSN csn1, CSN csn2)`	Compares this CSN with the provided CSN for order and returns a negative number if `csn1` is older than `csn2`, zero if they have the same age, or a positive number if `csn1` is newer than `csn2`.
`int`	CSN.`compareTo(CSN csn)`	Compares this CSN with the provided CSN for order and returns a negative number if this CSN is older than `csn`, zero if they have the same age, or a positive number if this CSN is newer than `csn`.
`boolean`	MultiDomainServerState.`cover(Dn baseDN, CSN csn)`	Test if this object covers the provided CSN for the provided baseDN.
`boolean`	ServerState.`cover(CSN covered)`	Checks that the CSN given as a parameter is in this ServerState.
`boolean`	CSN.`isNewerThan(CSN csn)`	Returns `true` if this CSN is newer than the provided CSN.
`boolean`	CSN.`isNewerThanOrEqualTo(CSN csn)`	Returns `true` if this CSN is newer than or equal to the provided CSN.
`boolean`	CSN.`isOlderThan(CSN csn)`	Returns `true` if this CSN is older than the provided CSN.
`boolean`	CSN.`isOlderThanOrEqualTo(CSN csn)`	Returns `true` if this CSN is older than or equal to the provided CSN.
`boolean`	ServerState.`removeCSN(CSN expectedCSN)`	Removes the mapping to the provided CSN if it is present in this ServerState.
`boolean`	MultiDomainServerState.`update(Dn baseDN, CSN csn)`	Update the ServerState of the provided baseDN with the replication `CSN` provided.
`boolean`	ServerState.`update(CSN csn)`	Forward update the Server State with a CSN.

Uses of CSN in org.opends.server.replication.plugin

Methods in org.opends.server.replication.plugin that return CSN
Modifier and Type	Method	Description
`abstract CSN`	AttrHistorical.`getDeleteTime()`	Returns the last time when this attribute was deleted.
`CSN`	AttrHistoricalMultiple.`getDeleteTime()`
`CSN`	AttrHistoricalSingle.`getDeleteTime()`
`CSN`	EntryHistorical.`getEntryADDDate()`	Returns the CSN of the operation that added this entry.
`CSN`	EntryHistorical.`getEntryMODDNDate()`	Returns the CSN of the operation that renamed this entry.
`CSN`	AttrValueHistorical.`getValueDeleteTime()`	Get the last time when the value was deleted.
`CSN`	AttrValueHistorical.`getValueUpdateTime()`	Get the last time when the value was updated.

Methods in org.opends.server.replication.plugin with parameters of type CSN
Modifier and Type	Method	Description
`void`	EntryHistorical.`addAttrHistoricalAddValue(AttributeDescription attributeDescription, CSN csn, ByteString value)`	Updates this entry historical information with the provided add modification.
`void`	EntryHistorical.`addAttrHistoricalDeleteAttr(AttributeDescription attributeDescription, CSN csn)`	Updates this entry historical information with the provided delete attribute modification.
`void`	EntryHistorical.`addAttrHistoricalDeleteValue(AttributeDescription attributeDescription, CSN csn, ByteString value)`	Updates this entry historical information with the provided delete modification.
`void`	EntryHistorical.`addAttrHistoricalReplaceValue(AttributeDescription attributeDescription, CSN csn, ByteString value)`	Updates this entry historical information with the provided replace modification.
`abstract void`	AttrHistorical.`processLocalOrNonConflictModification(CSN csn, Modification mod)`	This method calculates the historical information and update the hist attribute to store the historical information for modify operation that does not conflict with previous operation.
`void`	AttrHistoricalMultiple.`processLocalOrNonConflictModification(CSN csn, Modification mod)`
`void`	AttrHistoricalSingle.`processLocalOrNonConflictModification(CSN csn, Modification mod)`
`abstract Modification`	AttrHistorical.`replayOperation(CSN csn, Entry modifiedEntry, Modification mod)`	This method will be called when replaying an operation.
`Modification`	AttrHistoricalMultiple.`replayOperation(CSN csn, Entry modifiedEntry, Modification m)`
`Modification`	AttrHistoricalSingle.`replayOperation(CSN csn, Entry modifiedEntry, Modification mod)`
`void`	EntryHistorical.`setEntryADDDate(CSN csn)`	Sets the CSN of the operation that added this entry.
`void`	EntryHistorical.`setEntryMODDNDate(CSN csn)`	Sets the CSN of the operation that renamed this entry.

Uses of CSN in org.opends.server.replication.protocol

Methods in org.opends.server.replication.protocol that return CSN
Modifier and Type	Method	Description
`CSN`	ChangeTimeHeartbeatMsg.`getCSN()`	Get a CSN with the transmitted change time.
`CSN`	OperationContext.`getCSN()`	Gets the CSN of the Operation.
`static CSN`	OperationContext.`getCSN(PluginOperation op)`	Get the CSN of an operation from the synchronization context attached to the provided operation.
`CSN`	UpdateMsg.`getCSN()`	Get the CSN from the message.
`CSN`	ByteArrayScanner.`nextCsn()`	Reads the next CSN.
`CSN`	ByteArrayScanner.`nextCsnUtf8()`	Reads the next CSN that was encoded as a UTF8 string.

Methods in org.opends.server.replication.protocol with parameters of type CSN
Modifier and Type	Method	Description
`ByteArrayBuilder`	ByteArrayBuilder.`appendCsn(CSN csn, CSN.CsnVersion version)`	Append a CSN to this ByteArrayBuilder.
`ByteArrayBuilder`	ByteArrayBuilder.`appendCsnUtf8(CSN csn, CSN.CsnVersion version)`	Append a CSN to this ByteArrayBuilder by converting it to a String then encoding that string to a UTF-8 byte array.

Constructors in org.opends.server.replication.protocol with parameters of type CSN
Constructor	Description
`AddContext(CSN csn, UUID entryUUID, UUID parentEntryUUID)`	Creates a new AddContext with the provided information.
`AddMsg(CSN csn, Dn dn, UUID entryUuid, UUID parentEntryUuid, byte[] encodedAttributes, byte[] encodedEclIncludes)`	Creates a new AddMessage.
`AddMsg(CSN csn, Entry entry, UUID entryUuid, UUID parentEntryUuid)`	Creates a new AddMessage.
`ChangeTimeHeartbeatMsg(CSN csn)`	Constructor of a Change Time Heartbeat message providing the change time value in a CSN.
`DeleteContext(CSN csn, UUID entryUUID)`	Creates a new DeleteContext with the provided information.
`DeleteMsg(Dn dn, CSN csn, UUID entryUUID)`	Creates a new delete message.
`DeleteMsg(CSN csn, Dn dn, UUID entryUUID, String initiatorsName, byte[] encodedEclIncludes, boolean subtreeDelete)`	Creates a new delete message.
`ModifyCommonMsg(CSN csn, UUID entryUUID, Dn dn)`
`ModifyContext(CSN csn, UUID entryUUID)`	Creates a new Modify Context with the provided parameters.
`ModifyDnContext(CSN csn, UUID entryUUID, UUID newSuperiorEntryUUID)`	Creates a new ModifyDN Context with the provided parameters.
`ModifyDNMsg(Dn dn, CSN csn, UUID entryUUID, UUID newSuperiorEntryUUID, boolean deleteOldRdn, Dn newSuperior, Rdn newRDN)`	Construct a new Modify DN message (no mods).
`ModifyDNMsg(Dn dn, CSN csn, UUID entryUUID, UUID newSuperiorEntryUUID, boolean deleteOldRdn, Dn newSuperior, Rdn newRDN, List<Modification> mods)`	Construct a new Modify DN message (with mods).
`ModifyDNMsg(CSN csn, Dn dn, UUID entryUUID, Rdn newRdn, Dn newSuperior, UUID newSuperiorEntryUUID, boolean deleteOldRdn, byte[] encodedMods, byte[] encodedEclIncludes)`	Creates a new ModifyDN message.
`ModifyMsg(CSN csn, Dn dn, UUID entryUUID, byte[] encodedMods, byte[] encodedEclIncludes)`	Creates a new Modify message using the provided information.
`ModifyMsg(CSN csn, Dn dn, UUID entryUUID, List<Modification> mods)`	Creates a new Modify message using the provided information.
`OperationContext(CSN csn, UUID entryUUID)`	Create a new OperationContext.
`ReplicaOfflineMsg(CSN offlineCSN)`	Constructor of a replica offline message providing the offline timestamp in a CSN.
`UpdateMsg(CSN csn)`	Creates a new UpdateMsg with the given information.

Uses of CSN in org.opends.server.replication.server.changelog.api

Methods in org.opends.server.replication.server.changelog.api that return CSN
Modifier and Type	Method	Description
`CSN`	UpdateRecord.`getCsn()`	Returns the CSN of the message.
`CSN`	ChangeNumberIndexRecord.`getCSN()`	Getter for the replication CSN field.
`CSN`	DBCursor.CursorOptions.`getDefaultCSN()`	Returns the default CSN.
`CSN`	RemovedReplicasStates.`getLastMessageCsn(ReplicaId replica)`	Returns the CSN for the last LDAP message from the provided replica.
`CSN`	RemovedReplicasStates.`getLastUpdateCsn(ReplicaId replica)`	Returns the CSN for the last `LDAPUpdateMsg` from the provided replica.
`CSN`	ReplicationDomainDB.ReplicaDbFileContent.`getNewestCsn()`	Returns the newest CSN in the Replica DB file.
`CSN`	ReplicationDomainDB.ReplicaDbFileContent.`getOldestCsn()`	Returns the oldest CSN in the Replica DB file.

Methods in org.opends.server.replication.server.changelog.api with parameters of type CSN
Modifier and Type	Method	Description
`DBCursor<UpdateMsg>`	ReplicationDomainDB.`getCursorFrom(DomainReplicaId replica, CSN startCSN, DBCursor.CursorOptions options)`	Generates a `DBCursor` for one replicaDB for the specified replication domain and replica id starting before, at or after the provided `CSN`, depending on the provided matching and positioning strategies.
`void`	ReplicationDomainDB.`replicaHeartbeat(Dn baseDN, CSN heartbeatCSN)`	Let the DB know this replica is alive.
`void`	ChangeNumberIndexDB.`resetChangeNumberTo(long newFirstCN, Dn baseDN, CSN newFirstCSN)`	Resets ChangeNumber index to the given number and CSN.
`void`	RemovedReplicasStates.`update(CSN lastUpdate, CSN lastMessage)`	Updates the removed replicas states with the provided CSNs.

Constructors in org.opends.server.replication.server.changelog.api with parameters of type CSN
Constructor	Description
`ChangeNumberIndexRecord(long changeNumber, Dn baseDN, CSN csn)`	Builds an instance of this class.
`ChangeNumberIndexRecord(Dn baseDN, CSN csn)`	Builds an instance of this class, with changeNumber equal to 0.
`CursorOptions(DBCursor.PositionStrategy strategy, CSN defaultCSN)`	Creates options with provided positioning strategy and default CSN.
`ReplicaDbFileContent(CSN oldestCsn, CSN newestCsn, int numberOfUpdates, int numberOfReplicaOfflineMessages)`	Constructs a new ReplicaDbFileContent with the specified parameters.

Uses of CSN in org.opends.server.replication.server.changelog.file

Methods in org.opends.server.replication.server.changelog.file with parameters of type CSN
Modifier and Type	Method	Description
`void`	DomainDBCursor.`addReplicaDB(DomainReplicaId replicaId, CSN startCSN)`	Adds a replicaDB for this cursor to iterate over.
`DBCursor<UpdateMsg>`	FileChangelogDB.`getCursorFrom(DomainReplicaId replica, CSN startCsn, DBCursor.CursorOptions options)`
`static void`	FileChangelogDB.`migrateOfflineStateToChangelog(Path replicationDbDir, Path replicaIdDir, LogCryptoCfg cryptoCfg, CSN offlineCsn)`	Used by upgrade only: Append the CSN at which the server/domains was considered offline if this CSN appears to be more recent than the last message already contained in the log, otherwise the changelog is not modified.
`void`	ChangeNumberIndexer.`notifyHeartbeat(Dn baseDn, CSN heartbeatCsn)`	Ensures the medium consistency point is updated by heartbeats.
`void`	FileChangelogDB.`replicaHeartbeat(Dn baseDN, CSN heartbeatCsn)`

Uses of CSN in org.opends.server.replication.service

Methods in org.opends.server.replication.service that return CSN
Modifier and Type	Method	Description
`CSN`	ReplicationDomain.`getLastLocalChange()`	Returns the CSN of the last Change that was fully processed by this ReplicationDomain.

Uses of CSN in org.opends.server.tasks

Methods in org.opends.server.tasks with parameters of type CSN
Modifier and Type	Method	Description
`void`	PurgeConflictsHistoricalTask.`setProgressStats(CSN lastCSN, int purgeCount)`	Set the last CSN purged and the count of purged values in order to monitor the historical purge.