org.opends.server.backends

Class ChangelogBackend

java.lang.Object

org.opends.server.api.Backend<C>

org.opends.server.api.LocalBackend<LocalBackendCfg>

org.opends.server.backends.ChangelogBackend

All Implemented Interfaces:

RequestHandler, HealthStatusProvider

public class ChangelogBackend
extends LocalBackend<LocalBackendCfg>

A backend that provides access to the changelog, i.e. the "cn=changelog" suffix. It is a read-only backend that is created by a ReplicationServer and is not configurable.

There are two modes to search the changelog:

• Cookie mode: when a "ECL Cookie Exchange Control" is provided with the request. The cookie provided in the control is used to retrieve entries from the ReplicaDBs. The changeNumber attribute is not returned with the entries.
• Change number mode: when no "ECL Cookie Exchange Control" is provided with the request. The entries are retrieved using the ChangeNumberIndexDB and their attributes are set with the information from the ReplicaDBs. The changeNumber attribute value is set from the content of ChangeNumberIndexDB.

Searches flow

Here is the flow of searches within the changelog backend APIs:

• Normal searches only go through:
  1. search(SearchOperation) (once, single threaded)
• Persistent searches with changesOnly=false go through:
  1. registerPersistentSearch(PersistentSearch) (once, single threaded),
  2. search(SearchOperation) (once, single threaded)
  3. ChangelogBackend#notifyChangeNumberEntryAdded(Dn, long, String, UpdateMsg), and ChangelogBackend#notifyCookieEntryAdded(Dn, UpdateMsg) (multiple times, multi-threaded)
• Persistent searches with changesOnly=true go through:
  1. registerPersistentSearch(PersistentSearch) (once, single threaded)
  2. ChangelogBackend#notifyChangeNumberEntryAdded(Dn, long, String, UpdateMsg), and ChangelogBackend#notifyCookieEntryAdded(Dn, UpdateMsg) (multiple times, multi-threaded)

See Also:

ReplicationServer

Nested Class Summary

Nested classes/interfaces inherited from class org.opends.server.api.LocalBackend

LocalBackend.BackendOperation

Field Summary

Fields

Modifier and Type	Field and Description
static String	BACKEND_ID The id of this backend.
static Dn	CHANGELOG_BASE_DN The base DN for the external change log.

Constructor Summary

Constructors

Constructor and Description
ChangelogBackend(ReplicationServer replicationServer, Predicate<Dn> isEclEnabledDomain) Creates a new backend with the provided replication server.

Method Summary

Modifier and Type	Method and Description
void	addEntry(Entry entry, AddOperation addOperation) Adds the provided entry to this backend.
void	closeBackend() Performs any necessary work to finally close this backend, particularly closing any underlying databases or connections and deregistering any suffixes that it manages with the Directory Server.
void	configureBackend(LocalBackendCfg config, ServerContext serverContext) Configure this backend based on the information in the provided configuration.
void	deleteEntry(Dn entryDN, DeleteOperation deleteOperation) Removes the specified entry from this backend.
Set<Dn>	getBaseDNs() Retrieves the set of base-level DNs that may be used within this backend.
Entry	getEntry(Dn entryDN) Retrieves the requested entry from this backend.
long	getEntryCount() Retrieves the total number of entries contained in this backend, if that information is available.
long	getNumberOfChildren(Dn parentDN) Retrieves the number of subordinates immediately below the requested entry.
long	getNumberOfEntriesInBaseDN(Dn baseDN) Retrieves the number of entries for the specified base DN including all entries from the requested entry to the lowest level in the tree.
Set<String>	getSupportedControls() Retrieves the OIDs of the controls that may be supported by this backend.
ConditionResult	hasSubordinates(Dn entryDN) Indicates whether the requested entry has any subordinates.
boolean	isIndexed(AttributeType attributeType, IndexType indexType) Indicates whether search operations which target the specified attribute in the indicated manner would be considered indexed in this backend.
boolean	isPublicBackend() Indicates whether the base DNs of this backend should be considered public or private.
void	notifyChangeNumberEntryAdded(Dn baseDN, long changeNumber, String cookie, LDAPUpdateMsg updateMsg) Notifies persistent searches of this backend that a new change number entry was added to it.
void	notifyCookieEntryAdded(Dn baseDN, LDAPUpdateMsg updateMsg) Notifies persistent searches of this backend that a new cookie entry was added to it.
void	openBackend() Opens this backend based on the information provided when the backend was configured.
void	registerPersistentSearch(PersistentSearch pSearch) Registers the provided persistent search operation with this backend so that it will be notified of any add, delete, modify, or modify DN operations that are performed.
void	renameEntry(Dn currentDN, Entry entry, ModifyDnOperation modifyDNOperation) Moves and/or renames the provided entry in this backend, altering any subordinate entries as necessary.
void	replaceEntry(Entry oldEntry, Entry newEntry, ModifyOperation modifyOperation) Replaces the specified entry with the provided entry in this backend.
void	search(SearchOperation searchOperation) Processes the specified search in this backend.
static void	updateCookieToMediumConsistencyPoint(MultiDomainServerState cookie, ECLMultiDomainDBCursor cursor, ChangeNumberIndexRecord cnIndexRecord) Rebuilds the changelogcookie starting at the newest change number index record.

Methods inherited from class org.opends.server.api.LocalBackend

createBackup, deregisterBackendMonitor, entryExists, exportLDIF, finalizeBackend, getLocalBackendMonitor, getPersistentSearches, getWritabilityMode, handle, handlesEntry, handlesEntry, importLDIF, isIndexed, rebuildBackend, registerBackendMonitor, removeBackup, restoreBackup, setWritabilityMode, supports, supportsControl, verifyBackend

Methods inherited from class org.opends.server.api.Backend

getBackendID, getHealthStatus, getSupportedFeatures, isConfigurationAcceptable, setBackendID, toString

Methods inherited from class java.lang.Object

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

Field Detail

BACKEND_ID

public static final String BACKEND_ID

The id of this backend.

See Also:

Constant Field Values

CHANGELOG_BASE_DN

public static final Dn CHANGELOG_BASE_DN

The base DN for the external change log.

Constructor Detail

ChangelogBackend

public ChangelogBackend(ReplicationServer replicationServer,
                        Predicate<Dn> isEclEnabledDomain)

Creates a new backend with the provided replication server.

Parameters:

replicationServer - The replication server on which the changes are read.

isEclEnabledDomain - Returns whether a domain is enabled for the external changelog.

Method Detail

configureBackend

public void configureBackend(LocalBackendCfg config,
                             ServerContext serverContext)
                      throws ConfigException

Description copied from class: Backend

Configure this backend based on the information in the provided configuration. When the method returns, the backend will have been configured (ready to be opened) but still unable to process operations.

Specified by:

configureBackend in class Backend<LocalBackendCfg>

Parameters:

config - The configuration of this backend.

serverContext - The server context for this instance

Throws:

ConfigException - If there is an error in the configuration.

openBackend

public void openBackend()
                 throws InitializationException

Description copied from class: LocalBackend

Opens this backend based on the information provided when the backend was configured. It also should open any underlying storage and register all suffixes with the server.

Specified by:

openBackend in class LocalBackend<LocalBackendCfg>

Throws:

InitializationException - If a problem occurs during opening that is not related to the server configuration.

See Also:

Backend.configureBackend(C, org.opends.server.core.ServerContext)

isPublicBackend

public boolean isPublicBackend()

Description copied from class: Backend

Indicates whether the base DNs of this backend should be considered public or private.

This method also controls the visibility of the associated naming contexts. i.e. if any base DN of this backend is a naming context, then it will be public or private, based on the value returned by this method.

Reminder: Public naming contexts are returned when querying the root DSE entry.

Specified by:

isPublicBackend in class Backend<LocalBackendCfg>

Returns:

true if this backend's baseDNs could be exposed as a public naming context, false if they must remain private naming contexts.

closeBackend

public void closeBackend()

Description copied from class: LocalBackend

Performs any necessary work to finally close this backend, particularly closing any underlying databases or connections and deregistering any suffixes that it manages with the Directory Server.

It will be called as final step of finalizeBackend(), so subclasses might override it.

Overrides:

closeBackend in class LocalBackend<LocalBackendCfg>

getBaseDNs

public Set<Dn> getBaseDNs()

Description copied from class: Backend

Retrieves the set of base-level DNs that may be used within this backend.

Specified by:

getBaseDNs in class Backend<LocalBackendCfg>

Returns:

The set of base-level DNs that may be used within this backend.

isIndexed

public boolean isIndexed(AttributeType attributeType,
                         IndexType indexType)

Description copied from class: LocalBackend

Indicates whether search operations which target the specified attribute in the indicated manner would be considered indexed in this backend. The operation should be considered indexed only if the specified operation can be completed efficiently within the backend.

Note that this method should return a general result that covers all values of the specified attribute. If a the specified attribute is indexed in the indicated manner but some particular values may still be treated as unindexed (e.g., if the number of entries with that attribute value exceeds some threshold), then this method should still return true for the specified attribute and index type.

Specified by:

isIndexed in class LocalBackend<LocalBackendCfg>

Parameters:

attributeType - The attribute type for which to make the determination.

indexType - The index type for which to make the determination.

Returns:

true if search operations targeting the specified attribute in the indicated manner should be considered indexed, or false if not.

getEntry

public Entry getEntry(Dn entryDN)
               throws LdapException

Description copied from class: LocalBackend

Retrieves the requested entry from this backend. The caller is not required to hold any locks on the specified DN.

Specified by:

getEntry in class LocalBackend<LocalBackendCfg>

Parameters:

entryDN - The distinguished name of the entry to retrieve.

Returns:

The requested entry, or null if the entry does not exist.

Throws:

LdapException - If a problem occurs while trying to retrieve the entry.

hasSubordinates

public ConditionResult hasSubordinates(Dn entryDN)
                                throws LdapException

Description copied from class: LocalBackend

Indicates whether the requested entry has any subordinates.

Specified by:

hasSubordinates in class LocalBackend<LocalBackendCfg>

Parameters:

entryDN - The distinguished name of the entry.

Returns:

ConditionResult.TRUE if the entry has one or more subordinates or ConditionResult.FALSE otherwise or ConditionResult.UNDEFINED if it can not be determined.

Throws:

LdapException - If a problem occurs while trying to retrieve the entry.

getNumberOfEntriesInBaseDN

public long getNumberOfEntriesInBaseDN(Dn baseDN)
                                throws LdapException

Description copied from class: LocalBackend

Retrieves the number of entries for the specified base DN including all entries from the requested entry to the lowest level in the tree.

Specified by:

getNumberOfEntriesInBaseDN in class LocalBackend<LocalBackendCfg>

Parameters:

baseDN - The base distinguished name.

Returns:

The number of subordinate entries including the base dn.

Throws:

LdapException - If baseDN isn't a base dn managed by this backend or if a problem occurs while trying to retrieve the entry.

getNumberOfChildren

public long getNumberOfChildren(Dn parentDN)
                         throws LdapException

Description copied from class: LocalBackend

Retrieves the number of subordinates immediately below the requested entry.

Specified by:

getNumberOfChildren in class LocalBackend<LocalBackendCfg>

Parameters:

parentDN - The distinguished name of the parent.

Returns:

The number of subordinate entries for the requested entry.

Throws:

LdapException - If baseDN isn't a base dn managed by this backend or if a problem occurs while trying to retrieve the entry.

notifyCookieEntryAdded

public void notifyCookieEntryAdded(Dn baseDN,
                                   LDAPUpdateMsg updateMsg)
                            throws ChangelogException

Notifies persistent searches of this backend that a new cookie entry was added to it.

Note: This method correspond to the "persistent search" phase. It is executed multiple times per persistent search, multi-threaded, until the persistent search is cancelled.

This method must only be called after the provided data have been persisted to disk.

Parameters:

baseDN - the baseDN of the newly added entry.

updateMsg - the update message of the newly added entry

Throws:

ChangelogException - If a problem occurs while notifying of the newly added entry.

notifyChangeNumberEntryAdded

public void notifyChangeNumberEntryAdded(Dn baseDN,
                                         long changeNumber,
                                         String cookie,
                                         LDAPUpdateMsg updateMsg)
                                  throws ChangelogException

Notifies persistent searches of this backend that a new change number entry was added to it.

Note: This method correspond to the "persistent search" phase. It is executed multiple times per persistent search, multi-threaded, until the persistent search is cancelled.

This method must only be called after the provided data have been persisted to disk.

Parameters:

baseDN - the baseDN of the newly added entry.

changeNumber - the change number of the newly added entry. It will be greater than zero for entries added to the change number index and less than or equal to zero for entries added to any replica DB

cookie - a string representing the cookie of the newly added entry. This is only meaningful for entries added to the change number index

updateMsg - the update message of the newly added entry

Throws:

ChangelogException - If a problem occurs while notifying of the newly added entry.

addEntry

public void addEntry(Entry entry,
                     AddOperation addOperation)
              throws LdapException

Description copied from class: LocalBackend

Adds the provided entry to this backend. This method must ensure that the entry is appropriate for the backend and that no entry already exists with the same DN. The caller must hold a write lock on the DN of the provided entry.

Specified by:

addEntry in class LocalBackend<LocalBackendCfg>

Parameters:

entry - The entry to add to this backend.

addOperation - The add operation with which the new entry is associated. This may be null for adds performed internally.

Throws:

LdapException - If a problem occurs while trying to add the entry.

CancelledResultException - If this backend noticed and reacted to a request to cancel or abandon the add operation.

deleteEntry

public void deleteEntry(Dn entryDN,
                        DeleteOperation deleteOperation)
                 throws LdapException

Description copied from class: LocalBackend

Removes the specified entry from this backend. This method must ensure that the entry exists and that it does not have any subordinate entries (unless the backend supports a subtree delete operation and the client included the appropriate information in the request). The caller must hold a write lock on the provided entry DN.

Specified by:

deleteEntry in class LocalBackend<LocalBackendCfg>

Parameters:

entryDN - The DN of the entry to remove from this backend.

deleteOperation - The delete operation with which this action is associated. This may be null for deletes performed internally.

Throws:

LdapException - If a problem occurs while trying to remove the entry.

CancelledResultException - If this backend noticed and reacted to a request to cancel or abandon the delete operation.

replaceEntry

public void replaceEntry(Entry oldEntry,
                         Entry newEntry,
                         ModifyOperation modifyOperation)
                  throws LdapException

Description copied from class: LocalBackend

Replaces the specified entry with the provided entry in this backend. The backend must ensure that an entry already exists with the same DN as the provided entry. The caller must hold a write lock on the DN of the provided entry.

Specified by:

replaceEntry in class LocalBackend<LocalBackendCfg>

Parameters:

oldEntry - The original entry that is being replaced.

newEntry - The new entry to use in place of the existing entry with the same DN.

modifyOperation - The modify operation with which this action is associated. This may be null for modifications performed internally.

Throws:

LdapException - If a problem occurs while trying to replace the entry.

CancelledResultException - If this backend noticed and reacted to a request to cancel or abandon the modify operation.

renameEntry

public void renameEntry(Dn currentDN,
                        Entry entry,
                        ModifyDnOperation modifyDNOperation)
                 throws LdapException

Description copied from class: LocalBackend

Moves and/or renames the provided entry in this backend, altering any subordinate entries as necessary. This must ensure that an entry already exists with the provided current DN, and that no entry exists with the target DN of the provided entry. The caller must hold write locks on both the current DN and the new DN for the entry.

Specified by:

renameEntry in class LocalBackend<LocalBackendCfg>

Parameters:

currentDN - The current DN of the entry to be moved/renamed.

entry - The new content to use for the entry.

modifyDNOperation - The modify DN operation with which this action is associated. This may be null for modify DN operations performed internally.

Throws:

LdapException - If a problem occurs while trying to perform the rename.

CancelledResultException - If this backend noticed and reacted to a request to cancel or abandon the modify DN operation.

search

public void search(SearchOperation searchOperation)
            throws LdapException

Processes the specified search in this backend. Matching entries should be provided back to the core server using the SearchOperation.returnEntry method. The caller is not required to have any locks when calling this operation.

Runs the "initial search" phase (as opposed to a "persistent search" phase). The "initial search" phase is the only search run by normal searches, but it is also run by persistent searches with changesOnly=false. Persistent searches with changesOnly=true never execute this code.

Note: this method is executed only once per persistent search, single threaded.

Specified by:

search in class LocalBackend<LocalBackendCfg>

Parameters:

searchOperation - The search operation to be processed.

Throws:

LdapException - If a problem occurs while processing the search.

CancelledResultException - If this backend noticed and reacted to a request to cancel or abandon the search operation.

getSupportedControls

public Set<String> getSupportedControls()

Description copied from class: Backend

Retrieves the OIDs of the controls that may be supported by this backend.

Overrides:

getSupportedControls in class Backend<LocalBackendCfg>

Returns:

The OIDs of the controls that may be supported by this backend.

getEntryCount

public long getEntryCount()

Description copied from class: LocalBackend

Retrieves the total number of entries contained in this backend, if that information is available.

Specified by:

getEntryCount in class LocalBackend<LocalBackendCfg>

Returns:

The total number of entries contained in this backend, or -1 if that information is not available.

registerPersistentSearch

public void registerPersistentSearch(PersistentSearch pSearch)
                              throws LdapException

Description copied from class: LocalBackend

Registers the provided persistent search operation with this backend so that it will be notified of any add, delete, modify, or modify DN operations that are performed.

Overrides:

registerPersistentSearch in class LocalBackend<LocalBackendCfg>

Parameters:

pSearch - The persistent search operation to register with this backend

Throws:

LdapException - If a problem occurs while registering the persistent search

updateCookieToMediumConsistencyPoint

public static void updateCookieToMediumConsistencyPoint(MultiDomainServerState cookie,
                                                        ECLMultiDomainDBCursor cursor,
                                                        ChangeNumberIndexRecord cnIndexRecord)
                                                 throws ChangelogException

Rebuilds the changelogcookie starting at the newest change number index record.

It updates the provided cookie with the changes from the provided ECL cursor, up to (and including) the provided change number index record.

Therefore, after calling this method, the cursor is positioned to the change immediately following the provided change number index record.

Parameters:

cookie - the cookie to update

cursor - the cursor where to read changes from

cnIndexRecord - the change number index record to go right after

Throws:

ChangelogException - if any problem occurs