Package org.opends.server.backends.pluggable

Class EntryContainer

java.lang.Object

org.opends.server.backends.pluggable.EntryContainer

All Implemented Interfaces:

Closeable, AutoCloseable, ConfigurationChangeListener<PluggableBackendCfg>, SuffixContainer

public class EntryContainer
extends Object
implements SuffixContainer, ConfigurationChangeListener<PluggableBackendCfg>

Storage container for LDAP entries. Each base DN of a backend is given its own entry container. The entry container is the object that implements the guts of the backend API methods for LDAP operations.

Field Summary

Fields inherited from interface org.opends.server.backends.pluggable.SuffixContainer

ATTR_DEBUG_SEARCH_INDEX, DN2ID_INDEX_NAME, ID2CHILDREN_COUNT_NAME, ID2CHILDREN_INDEX_NAME, ID2ENTRY_INDEX_NAME, ID2SUBTREE_INDEX_NAME, REFERRAL_INDEX_NAME, STATE_INDEX_NAME

Method Summary

Modifier and Type	Method	Description
ConfigChangeResult	applyConfigurationChange(PluggableBackendCfg cfg)	Applies the configuration changes to this change listener.
void	clear()	Clear the contents of this entry container.
void	close()	Closes the entry container.
DN	getBaseDN()	Returns the baseDN that this suffix container is responsible for.
boolean	isConfigurationChangeAcceptable(PluggableBackendCfg cfg, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)	Indicates whether the proposed change to the configuration is acceptable to this change listener.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

close

public void close()
           throws StorageRuntimeException

Closes the entry container.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

StorageRuntimeException - If an error occurs in the storage.

getBaseDN

public DN getBaseDN()

Description copied from interface: SuffixContainer

Returns the baseDN that this suffix container is responsible for.

Specified by:

getBaseDN in interface SuffixContainer

Returns:

the baseDN that this suffix container is responsible for

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(PluggableBackendCfg cfg,
                                               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:

cfg - 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 cfg)

Description copied from interface: ConfigurationChangeListener

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<PluggableBackendCfg>

Parameters:

cfg - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.

clear

public void clear()
           throws StorageRuntimeException

Clear the contents of this entry container.

Throws:

StorageRuntimeException - If an error occurs while removing the entry container.

toString

public String toString()

Overrides:

toString in class Object