Package org.opends.server.backends

Class MonitorBackend

java.lang.Object

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

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

org.opends.server.backends.MonitorBackend

All Implemented Interfaces:

ConfigurationChangeListener<MonitorBackendCfg>, RequestHandler, HealthStatusProvider

public final class MonitorBackend
extends LocalBackend<MonitorBackendCfg>
implements ConfigurationChangeListener<MonitorBackendCfg>

This class defines a backend to hold Directory Server monitor entries. It will not actually store anything, but upon request will retrieve the requested monitor and dynamically generate the associated entry. It will also construct a base monitor entry with some useful server-wide data.

Nested Class Summary

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

LocalBackend.BackendOperation

Constructor Summary

Constructors

Constructor	Description
MonitorBackend()

Method Summary

Modifier and Type	Method	Description
void	addEntry(Entry entry, AddOperation addOperation)	Adds the provided entry to this backend.
ConfigChangeResult	applyConfigurationChange(MonitorBackendCfg backendCfg)	Applies the configuration changes to this change listener.
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(MonitorBackendCfg 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.
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.
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.
protected ServerContext	getServerContext()	Returns the server context used by this backend.
ConditionResult	hasSubordinates(Dn entryDN)	Indicates whether the requested entry has any subordinates.
boolean	isConfigurationChangeAcceptable(MonitorBackendCfg backendCfg, List<LocalizableMessage> unacceptableReasons)	Indicates whether the proposed change to the configuration is acceptable to this change listener.
boolean	isIndexed(AttributeType attributeType, MatchingRule matchingRule)	Indicates whether extensible match search operations that target the specified attribute with the given matching rule should be considered indexed in this backend.
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	openBackend()	Opens this backend based on the information provided when the backend was configured.
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.

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

deregisterBackendMonitor, getAndClearOfflineChanges, getLocalBackendMonitor, getPersistentSearches, getWritabilityMode, handle, handlesEntry, handlesEntry, importLDIF, isIndexed, rebuildBackend, registerBackendMonitor, registerPersistentSearch, sampleEntries, setWritabilityMode, supports, supportsControl, verifyBackend

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

getBackendID, getHealthStatus, getSupportedControls, getSupportedFeatures, isConfigurationAcceptable, setBackendID, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

MonitorBackend

public MonitorBackend()

Method Detail

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.

Overrides:

finalizeBackend in class LocalBackend<MonitorBackendCfg>

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<MonitorBackendCfg>

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.

applyConfigurationChange

public ConfigChangeResult applyConfigurationChange(MonitorBackendCfg backendCfg)

Description copied from interface: ConfigurationChangeListener

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<MonitorBackendCfg>

Parameters:

backendCfg - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.

configureBackend

public void configureBackend(MonitorBackendCfg 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<MonitorBackendCfg>

Parameters:

config - The configuration of this backend.

serverContext - The server context for this instance

Throws:

ConfigException - If there is an error in the configuration.

getServerContext

protected ServerContext getServerContext()

Description copied from class: Backend

Returns the server context used by this backend.

Overrides:

getServerContext in class Backend<MonitorBackendCfg>

Returns:

the server context used by this backend

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<MonitorBackendCfg>

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.

entryExists

public boolean entryExists(Dn entryDN)

Description copied from class: LocalBackend

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.

Overrides:

entryExists in class LocalBackend<MonitorBackendCfg>

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.

exportLDIF

public void exportLDIF(LDIFExportConfig exportConfig)

Description copied from class: LocalBackend

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

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

Overrides:

exportLDIF in class LocalBackend<MonitorBackendCfg>

Parameters:

exportConfig - The configuration to use when performing the export.

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<MonitorBackendCfg>

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<MonitorBackendCfg>

Returns:

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

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<MonitorBackendCfg>

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.

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<MonitorBackendCfg>

Returns:

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

hasSubordinates

public ConditionResult hasSubordinates(Dn entryDN)

Description copied from class: LocalBackend

Indicates whether the requested entry has any subordinates.

Specified by:

hasSubordinates in class LocalBackend<MonitorBackendCfg>

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.

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<MonitorBackendCfg>

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<MonitorBackendCfg>

Returns:

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

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(MonitorBackendCfg backendCfg,
                                               List<LocalizableMessage> unacceptableReasons)

Description copied from interface: ConfigurationChangeListener

Indicates whether the proposed change to the configuration is acceptable to this change listener.

Specified by:

isConfigurationChangeAcceptable in interface ConfigurationChangeListener<MonitorBackendCfg>

Parameters:

backendCfg - The new configuration containing the changes.

unacceptableReasons - A list that can be used to hold messages about why the provided configuration is not acceptable.

Returns:

Returns true if the proposed change is acceptable, or false if it is not.

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<MonitorBackendCfg>

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(AttributeType attributeType,
                         MatchingRule matchingRule)

Description copied from class: LocalBackend

Indicates whether extensible match search operations that target the specified attribute with the given matching rule should be considered indexed in this backend.

Specified by:

isIndexed in class LocalBackend<MonitorBackendCfg>

Parameters:

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

matchingRule - The matching rule for which to make the determination.

Returns:

true if extensible match search operations targeting the specified attribute with the given matching rule should be considered indexed, or false if not.

getNumberOfEntriesInBaseDN

public long getNumberOfEntriesInBaseDN(Dn baseDN)

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<MonitorBackendCfg>

Parameters:

baseDN - The base distinguished name.

Returns:

The number of subordinate entries including the base dn.

getNumberOfChildren

public long getNumberOfChildren(Dn parentDN)

Description copied from class: LocalBackend

Retrieves the number of subordinates immediately below the requested entry.

Specified by:

getNumberOfChildren in class LocalBackend<MonitorBackendCfg>

Parameters:

parentDN - The distinguished name of the parent.

Returns:

The number of subordinate entries for the requested entry.

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<MonitorBackendCfg>

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.

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<MonitorBackendCfg>

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.

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.

search

public void search(SearchOperation searchOperation)
            throws LdapException

Description copied from class: LocalBackend

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.

Specified by:

search in class LocalBackend<MonitorBackendCfg>

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.