Package org.opends.server.backends.pluggable

Class RootContainer

java.lang.Object

org.opends.server.backends.pluggable.RootContainer

All Implemented Interfaces:

ConfigurationChangeListener<PluggableBackendCfg>

public class RootContainer
extends Object
implements ConfigurationChangeListener<PluggableBackendCfg>

Wrapper class for a backend "container". Root container holds all the entry containers for each base DN. It also maintains all the openings and closings of the entry containers.

Method Summary

Modifier and Type	Method	Description
ConfigChangeResult	applyConfigurationChange(PluggableBackendCfg configuration)	Applies the configuration changes to this change listener.
Collection<EntryContainer>	getEntryContainers()	Return all the entry containers in this root container.
boolean	isConfigurationChangeAcceptable(PluggableBackendCfg configuration, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)	Indicates whether the proposed change to the configuration is acceptable to this change listener.
void	resetNextEntryID()	Resets the next entry ID counter to zero.

Methods inherited from class java.lang.Object

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

Method Detail

getEntryContainers

public Collection<EntryContainer> getEntryContainers()

Return all the entry containers in this root container.

Returns:

The entry containers in this root container.

resetNextEntryID

public void resetNextEntryID()

Resets the next entry ID counter to zero. This should only be used after clearing all trees.

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(PluggableBackendCfg configuration,
                                               List<org.forgerock.i18n.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<PluggableBackendCfg>

Parameters:

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

applyConfigurationChange

public ConfigChangeResult applyConfigurationChange(PluggableBackendCfg configuration)

Description copied from interface: ConfigurationChangeListener

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<PluggableBackendCfg>

Parameters:

configuration - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.