org.opends.server.api

Class LocalBackend<C extends Configuration>

java.lang.Object

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

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

Type Parameters:

C - the type of the BackendCfg for the current backend

All Implemented Interfaces:

RequestHandler, HealthStatusProvider

Direct Known Subclasses:

BackendImpl, BackupBackend, ChangelogBackend, ConfigurationBackend, LDIFBackend, MemoryBackend, MonitorBackend, NullBackend, RootDSEBackend, SchemaBackend, TaskBackend, TrustStoreBackend

@PublicAPI(stability=VOLATILE,
           mayExtend=true)
public abstract class LocalBackend<C extends Configuration>
extends Backend<C>

This class defines the set of methods and structures that must be implemented for a Directory Server backend.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LocalBackend.BackendOperation Enumeration of optional backend operations.

Constructor Summary

Constructors

Constructor and Description
LocalBackend()

Method Summary

Modifier and Type	Method and Description
abstract 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	createBackup(BackupConfig backupConfig) Creates a backup of the contents of this backend in a form that may be restored at a later date if necessary.
abstract void	deleteEntry(Dn entryDN, DeleteOperation deleteOperation) Removes the specified entry from this backend.
void	deregisterBackendMonitor() Deregisters the backend monitor of this backend.
boolean	entryExists(Dn entryDN) Indicates whether an entry with the specified DN exists in the backend.
void	exportLDIF(LDIFExportConfig exportConfig) Exports the contents of this backend to LDIF.
void	finalizeBackend() Performs any necessary work to finalize this backend.
abstract Entry	getEntry(Dn entryDN) Retrieves the requested entry from this backend.
abstract long	getEntryCount() Retrieves the total number of entries contained in this backend, if that information is available.
protected LocalBackendMonitor<?>	getLocalBackendMonitor() Returns the local backend monitor associated with this backend.
abstract long	getNumberOfChildren(Dn parentDN) Retrieves the number of subordinates immediately below the requested entry.
abstract 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.
Queue<PersistentSearch>	getPersistentSearches() Returns the persistent searches currently active against this local backend.
WritabilityMode	getWritabilityMode() Retrieves the writability mode for this backend.
Flowable<Response>	handle(org.forgerock.services.context.Context context, Request request) Processes the provided request in a reactive way within this backend.
boolean	handlesEntry(Dn entryDN) Indicates whether this backend should be used to handle operations for the provided entry.
static boolean	handlesEntry(Dn entryDN, Collection<Dn> baseDNs, Collection<Dn> excludeDNs) Indicates whether a backend should be used to handle operations for the provided entry given the set of base DNs and exclude DNs.
abstract ConditionResult	hasSubordinates(Dn entryDN) Indicates whether the requested entry has any subordinates.
LDIFImportResult	importLDIF(LDIFImportConfig importConfig, ServerContext serverContext) Imports information from an LDIF file into this backend.
abstract 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	isIndexed(Filter filter) Indicates whether a subtree search using the provided filter would be indexed in this backend.
abstract void	openBackend() Opens this backend based on the information provided when the backend was configured.
void	rebuildBackend(RebuildConfig rebuildConfig, ServerContext serverContext) Rebuild indexes in the backend instance.
void	registerBackendMonitor() Registers a backend monitor for this backend.
void	registerPersistentSearch(PersistentSearch persistentSearch) 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	removeBackup(BackupDirectory backupDirectory, String backupID) Removes the specified backup if it is possible to do so.
abstract void	renameEntry(Dn currentDN, Entry entry, ModifyDnOperation modifyDNOperation) Moves and/or renames the provided entry in this backend, altering any subordinate entries as necessary.
abstract void	replaceEntry(Entry oldEntry, Entry newEntry, ModifyOperation modifyOperation) Replaces the specified entry with the provided entry in this backend.
void	restoreBackup(RestoreConfig restoreConfig) Restores a backup of the contents of this backend.
abstract void	search(SearchOperation searchOperation) Processes the specified search in this backend.
void	setWritabilityMode(WritabilityMode writabilityMode) Specifies the writability mode for this backend.
boolean	supports(LocalBackend.BackendOperation backendOperation) Indicates whether this backend supports the provided backend operation.
boolean	supportsControl(String controlOID) Indicates whether this backend supports the specified control.
long	verifyBackend(VerifyConfig verifyConfig) Verify the integrity of the backend instance.

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

configureBackend, getBackendID, getBaseDNs, getHealthStatus, getSupportedControls, getSupportedFeatures, isConfigurationAcceptable, isPublicBackend, setBackendID, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalBackend

public LocalBackend()

Method Detail

handle

public Flowable<Response> handle(org.forgerock.services.context.Context context,
                                 Request request)
                          throws Exception

Processes the provided request in a reactive way within this backend.

Parameters:

context - The context to process the request, which is expected to contain a RequestDJContext and a ClientContext

request - The request to process.

Returns:

a stream of responses

Throws:

Exception - If an error occurs

openBackend

public abstract void openBackend()
                          throws ConfigException,
                                 InitializationException

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 Backend<C extends Configuration>

Throws:

ConfigException - If an unrecoverable problem arises while opening the backend.

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)

finalizeBackend

public void finalizeBackend()

Description copied from class: Backend

Performs any necessary work to finalize this backend. The backend must be an opened backend, so do not use this method on backends where only configureBackend() has been called. This may be called during the Directory Server shutdown process or if a backend is disabled with the server online. It must not return until the backend is closed.

This method may not throw any exceptions. If any problems are encountered, then they may be logged but the closure should progress as completely as possible.

Specified by:

finalizeBackend in class Backend<C extends Configuration>

closeBackend

public 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.

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

isIndexed

public abstract 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. 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.

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.

isIndexed

public boolean isIndexed(Filter filter)

Indicates whether a subtree search using the provided filter would be indexed in this backend. This default implementation uses a rough set of logic that makes a best-effort determination. Subclasses that provide a more complete indexing mechanism may wish to override this method and provide a more accurate result.

Parameters:

filter - The search filter for which to make the determination.

Returns:

true if it is believed that the provided filter would be indexed in this backend, or false if not.

hasSubordinates

public abstract ConditionResult hasSubordinates(Dn entryDN)
                                         throws LdapException

Indicates whether the requested entry has any subordinates.

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.

getNumberOfChildren

public abstract long getNumberOfChildren(Dn parentDN)
                                  throws LdapException

Retrieves the number of subordinates immediately below the requested entry.

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.

NullPointerException - if baseDN is null.

getNumberOfEntriesInBaseDN

public abstract long getNumberOfEntriesInBaseDN(Dn baseDN)
                                         throws LdapException

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

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.

NullPointerException - if baseDN is null.

entryExists

public boolean entryExists(Dn entryDN)
                    throws LdapException

Indicates whether an entry with the specified DN exists in the backend. The default implementation calls getEntry, but backend implementations may override this with a more efficient version. The caller is not required to hold any locks on the specified DN.

Parameters:

entryDN - The DN of the entry for which to determine existence.

Returns:

true if the specified entry exists in this backend, or false if it does not.

Throws:

LdapException - If a problem occurs while trying to make the determination.

getEntry

public abstract Entry getEntry(Dn entryDN)
                        throws LdapException

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

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.

addEntry

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

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.

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 abstract void deleteEntry(Dn entryDN,
                                 DeleteOperation deleteOperation)
                          throws LdapException,
                                 CancelledResultException

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.

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 abstract void replaceEntry(Entry oldEntry,
                                  Entry newEntry,
                                  ModifyOperation modifyOperation)
                           throws LdapException,
                                  CancelledResultException

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.

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 abstract void renameEntry(Dn currentDN,
                                 Entry entry,
                                 ModifyDnOperation modifyDNOperation)
                          throws LdapException,
                                 CancelledResultException

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.

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 abstract void search(SearchOperation searchOperation)
                     throws LdapException,
                            CancelledResultException

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.

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.

supports

public boolean supports(LocalBackend.BackendOperation backendOperation)

Indicates whether this backend supports the provided backend operation.

Parameters:

backendOperation - the backend operation

Returns:

true if this backend supports the provided backend operation, false otherwise.

exportLDIF

public void exportLDIF(LDIFExportConfig exportConfig)
                throws LdapException

Exports the contents of this backend to LDIF. This method should only be called if supports(BackendOperation) with LocalBackend.BackendOperation.LDIF_EXPORT returns true.

Note that the server will not explicitly initialize this backend before calling this method.

Parameters:

exportConfig - The configuration to use when performing the export.

Throws:

LdapException - If a problem occurs while performing the LDIF export.

importLDIF

public LDIFImportResult importLDIF(LDIFImportConfig importConfig,
                                   ServerContext serverContext)
                            throws LdapException

Imports information from an LDIF file into this backend. This method should only be called if supports(BackendOperation) with LocalBackend.BackendOperation.LDIF_IMPORT returns true.

Note that the server will not explicitly initialize this backend before calling this method.

Parameters:

importConfig - The configuration to use when performing the import.

serverContext - The server context

Returns:

Information about the result of the import processing.

Throws:

LdapException - If a problem occurs while performing the LDIF import.

verifyBackend

public long verifyBackend(VerifyConfig verifyConfig)
                   throws InitializationException,
                          ConfigException,
                          LdapException

Verify the integrity of the backend instance.

Parameters:

verifyConfig - The verify configuration.

Returns:

The results of the operation.

Throws:

ConfigException - If an unrecoverable problem arises during initialization.

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

LdapException - If a Directory Server error occurs.

rebuildBackend

public void rebuildBackend(RebuildConfig rebuildConfig,
                           ServerContext serverContext)
                    throws InitializationException,
                           ConfigException,
                           LdapException

Rebuild indexes in the backend instance. Note that the server will not explicitly initialize this backend before calling this method.

Parameters:

rebuildConfig - The rebuild configuration.

serverContext - The server context for this instance

Throws:

ConfigException - If an unrecoverable problem arises during initialization.

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

LdapException - If a Directory Server error occurs.

createBackup

public void createBackup(BackupConfig backupConfig)
                  throws LdapException

Creates a backup of the contents of this backend in a form that may be restored at a later date if necessary. This method should only be called if supports(BackendOperation) with LocalBackend.BackendOperation.BACKUP returns true.

Note that the server will not explicitly initialize this backend before calling this method.

Parameters:

backupConfig - The configuration to use when performing the backup.

Throws:

LdapException - If a problem occurs while performing the backup.

removeBackup

public void removeBackup(BackupDirectory backupDirectory,
                         String backupID)
                  throws LdapException

Removes the specified backup if it is possible to do so.

Parameters:

backupDirectory - The backup directory structure with which the specified backup is associated.

backupID - The backup ID for the backup to be removed.

Throws:

LdapException - If it is not possible to remove the specified backup for some reason (e.g., no such backup exists or there are other backups that are dependent upon it).

restoreBackup

public void restoreBackup(RestoreConfig restoreConfig)
                   throws LdapException

Restores a backup of the contents of this backend. This method should only be called if supports(BackendOperation) with BackendOperation#RESTORE returns true.

Note that the server will not explicitly initialize this backend before calling this method.

Parameters:

restoreConfig - The configuration to use when performing the restore.

Throws:

LdapException - If a problem occurs while performing the restore.

getWritabilityMode

public final WritabilityMode getWritabilityMode()

Retrieves the writability mode for this backend.

Returns:

The writability mode for this backend.

setWritabilityMode

public final void setWritabilityMode(WritabilityMode writabilityMode)

Specifies the writability mode for this backend.

Parameters:

writabilityMode - The writability mode for this backend.

registerPersistentSearch

public void registerPersistentSearch(PersistentSearch persistentSearch)
                              throws LdapException

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.

Parameters:

persistentSearch - The persistent search operation to register with this backend

Throws:

LdapException - If a problem occurs while registering the persistent search

getPersistentSearches

public Queue<PersistentSearch> getPersistentSearches()

Returns the persistent searches currently active against this local backend.

Returns:

the list of persistent searches currently active against this local backend

getEntryCount

public abstract long getEntryCount()

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

Returns:

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

handlesEntry

public final boolean handlesEntry(Dn entryDN)

Indicates whether this backend should be used to handle operations for the provided entry.

Parameters:

entryDN - The DN of the entry for which to make the determination.

Returns:

true if this backend handles operations for the provided entry, or false if it does not.

registerBackendMonitor

public void registerBackendMonitor()

Description copied from class: Backend

Registers a backend monitor for this backend.

Overrides:

registerBackendMonitor in class Backend<C extends Configuration>

getLocalBackendMonitor

protected LocalBackendMonitor<?> getLocalBackendMonitor()

Returns the local backend monitor associated with this backend.

Implementations may override this method in order to provide custom implementations.

Returns:

The local backend monitor associated with this backend.

deregisterBackendMonitor

public void deregisterBackendMonitor()

Description copied from class: Backend

Deregisters the backend monitor of this backend.

Overrides:

deregisterBackendMonitor in class Backend<C extends Configuration>

supportsControl

public final boolean supportsControl(String controlOID)

Indicates whether this backend supports the specified control.

Parameters:

controlOID - The OID of the control for which to make the determination.

Returns:

true if this backends supports the control with the specified OID, or false if it does not.

handlesEntry

public static boolean handlesEntry(Dn entryDN,
                                   Collection<Dn> baseDNs,
                                   Collection<Dn> excludeDNs)

Indicates whether a backend should be used to handle operations for the provided entry given the set of base DNs and exclude DNs.

Parameters:

entryDN - The DN of the entry for which to make the determination.

baseDNs - The set of base DNs for the backend.

excludeDNs - The set of DNs that should be excluded from the backend.

Returns:

true if the backend should handle operations for the provided entry, or false if it does not.