@PublicAPI(stability=PRIVATE)

Package org.opends.server.replication.server.changelog.api

This package contains the API for the changelog database.

See: Description

Interface Summary

Interface	Description
ChangelogDB	This interface is the entry point for the changelog database which stores the replication data on persistent storage.
ChangelogStateProvider	Small interface for common Replication Environment operations.
ChangeNumberIndexDB	This class stores an index of all the changes seen by this server in the form of ChangeNumberIndexRecords.
DBCursor<T>	Generic cursor interface into the changelog database.
ReplicationDomainDB	This interface allows to query or control the replication domain database(s) (composed of one or more ReplicaDBs) and query/update each ReplicaDB.

Class Summary

Class	Description
ChangeNumberIndexRecord	The Change Number Index Record class represents records stored in the ChangeNumberIndexDB.
DBCursor.CursorOptions	Options to create a cursor.
ReplicaId	Replica identifier comprised of the domain baseDN and its serverId within this domain.

Enum Summary

Enum	Description
DBCursor.KeyMatchingStrategy	Represents a cursor key matching strategy, which allow to choose if only the exact key must be found or if any key equal or lower/higher should match.
DBCursor.PositionStrategy	Represents a cursor positioning strategy, which allow to choose if the start point corresponds to the record at the provided key or the record just after the provided key.

Exception Summary

Exception	Description
AbortedChangelogCursorException	This exception is thrown when a cursor that has been aborted is used.
ChangelogException	This class define an Exception that must be used when some error condition was detected in the changelog database that cannot be recovered automatically.

Package org.opends.server.replication.server.changelog.api Description

This package contains the API for the changelog database. The changelog contains:

• a changelog of all the changes that happened on each server in the replication domain / suffix,
• a changelog as defined by draft-good-ldap-changelog,
• a state database containing specific information about each serverId in the suffix, and in particular the generationId for each server.

The changelog must be purged at regular intervals to ensure it does not consume too much space on disk.