org.opends.server.core

Class ConfigurationHandler

java.lang.Object

org.opends.server.core.ConfigurationHandler

All Implemented Interfaces:

org.forgerock.opendj.config.server.spi.ConfigurationRepository

public class ConfigurationHandler
extends Object
implements org.forgerock.opendj.config.server.spi.ConfigurationRepository

Responsible for managing configuration entries and listeners on these entries.

Constructor Summary

Constructors

Constructor and Description
ConfigurationHandler(ServerContext serverContext) Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	addEntry(org.forgerock.opendj.ldap.Entry entry) Add a configuration entry
void	deleteEntry(org.forgerock.opendj.ldap.DN dn) Delete a configuration entry.
void	deregisterAddListener(org.forgerock.opendj.ldap.DN dn, org.forgerock.opendj.config.server.spi.ConfigAddListener listener)
boolean	deregisterChangeListener(org.forgerock.opendj.ldap.DN dn, org.forgerock.opendj.config.server.spi.ConfigChangeListener listener)
void	deregisterDeleteListener(org.forgerock.opendj.ldap.DN dn, org.forgerock.opendj.config.server.spi.ConfigDeleteListener listener)
List<org.forgerock.opendj.config.server.spi.ConfigAddListener>	getAddListeners(org.forgerock.opendj.ldap.DN dn)
List<org.forgerock.opendj.config.server.spi.ConfigChangeListener>	getChangeListeners(org.forgerock.opendj.ldap.DN dn)
Set<org.forgerock.opendj.ldap.DN>	getChildren(org.forgerock.opendj.ldap.DN dn)
List<org.forgerock.opendj.config.server.spi.ConfigDeleteListener>	getDeleteListeners(org.forgerock.opendj.ldap.DN dn)
org.forgerock.opendj.ldap.Entry	getEntry(org.forgerock.opendj.ldap.DN dn)
org.forgerock.opendj.ldap.Entry	getRootEntry() Returns the configuration root entry.
boolean	hasEntry(org.forgerock.opendj.ldap.DN dn)
void	initialize() Initialize the configuration.
long	numSubordinates(org.forgerock.opendj.ldap.DN entryDN, boolean subtree) Retrieves the number of subordinates for the requested entry.
void	registerAddListener(org.forgerock.opendj.ldap.DN dn, org.forgerock.opendj.config.server.spi.ConfigAddListener listener)
void	registerChangeListener(org.forgerock.opendj.ldap.DN dn, org.forgerock.opendj.config.server.spi.ConfigChangeListener listener)
void	registerDeleteListener(org.forgerock.opendj.ldap.DN dn, org.forgerock.opendj.config.server.spi.ConfigDeleteListener listener)
void	replaceEntry(org.forgerock.opendj.ldap.Entry oldEntry, org.forgerock.opendj.ldap.Entry newEntry) Replaces the old configuration entry with the new configuration entry provided.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationHandler

public ConfigurationHandler(ServerContext serverContext)

Creates a new instance.

Parameters:

serverContext - The server context.

Method Detail

initialize

public void initialize()
                throws InitializationException

Initialize the configuration.

Throws:

InitializationException - If an error occurs during the initialization.

getRootEntry

public org.forgerock.opendj.ldap.Entry getRootEntry()

Returns the configuration root entry.

Returns:

the root entry

getEntry

public org.forgerock.opendj.ldap.Entry getEntry(org.forgerock.opendj.ldap.DN dn)
                                         throws org.forgerock.opendj.config.server.ConfigException

Specified by:

getEntry in interface org.forgerock.opendj.config.server.spi.ConfigurationRepository

Throws:

org.forgerock.opendj.config.server.ConfigException

hasEntry

public boolean hasEntry(org.forgerock.opendj.ldap.DN dn)
                 throws org.forgerock.opendj.config.server.ConfigException

Specified by:

hasEntry in interface org.forgerock.opendj.config.server.spi.ConfigurationRepository

Throws:

org.forgerock.opendj.config.server.ConfigException

getChildren

public Set<org.forgerock.opendj.ldap.DN> getChildren(org.forgerock.opendj.ldap.DN dn)
                                              throws org.forgerock.opendj.config.server.ConfigException

Specified by:

getChildren in interface org.forgerock.opendj.config.server.spi.ConfigurationRepository

Throws:

org.forgerock.opendj.config.server.ConfigException

numSubordinates

public long numSubordinates(org.forgerock.opendj.ldap.DN entryDN,
                   boolean subtree)
                     throws org.forgerock.opendj.config.server.ConfigException

Retrieves the number of subordinates for the requested entry.

Parameters:

entryDN - The distinguished name of the entry.

subtree - true to include all entries from the requested entry to the lowest level in the tree or false to only include the entries immediately below the requested entry.

Returns:

The number of subordinate entries

Throws:

org.forgerock.opendj.config.server.ConfigException - If a problem occurs while trying to retrieve the entry.

addEntry

public void addEntry(org.forgerock.opendj.ldap.Entry entry)
              throws DirectoryException

Add a configuration entry

The add is performed only if all Add listeners on the parent entry accept the changes. Once the change is accepted, entry is effectively added and all Add listeners are called again to apply the change resulting from this new entry.

Parameters:

entry - The configuration entry to add.

Throws:

DirectoryException - If an error occurs.

deleteEntry

public void deleteEntry(org.forgerock.opendj.ldap.DN dn)
                 throws DirectoryException

Delete a configuration entry.

The delete is performed only if all Delete listeners on the parent entry accept the changes. Once the change is accepted, entry is effectively deleted and all Delete listeners are called again to apply the change resulting from this deletion.

Parameters:

dn - DN of entry to delete.

Throws:

DirectoryException - If a problem occurs.

replaceEntry

public void replaceEntry(org.forgerock.opendj.ldap.Entry oldEntry,
                org.forgerock.opendj.ldap.Entry newEntry)
                  throws DirectoryException

Replaces the old configuration entry with the new configuration entry provided.

The replacement is performed only if all Change listeners on the entry accept the changes. Once the change is accepted, entry is effectively replaced and all Change listeners are called again to apply the change resulting from the replacement.

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.

Throws:

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

registerAddListener

public void registerAddListener(org.forgerock.opendj.ldap.DN dn,
                       org.forgerock.opendj.config.server.spi.ConfigAddListener listener)

Specified by:

registerAddListener in interface org.forgerock.opendj.config.server.spi.ConfigurationRepository

registerDeleteListener

public void registerDeleteListener(org.forgerock.opendj.ldap.DN dn,
                          org.forgerock.opendj.config.server.spi.ConfigDeleteListener listener)

Specified by:

registerDeleteListener in interface org.forgerock.opendj.config.server.spi.ConfigurationRepository

registerChangeListener

public void registerChangeListener(org.forgerock.opendj.ldap.DN dn,
                          org.forgerock.opendj.config.server.spi.ConfigChangeListener listener)

Specified by:

registerChangeListener in interface org.forgerock.opendj.config.server.spi.ConfigurationRepository

deregisterAddListener

public void deregisterAddListener(org.forgerock.opendj.ldap.DN dn,
                         org.forgerock.opendj.config.server.spi.ConfigAddListener listener)

Specified by:

deregisterAddListener in interface org.forgerock.opendj.config.server.spi.ConfigurationRepository

deregisterDeleteListener

public void deregisterDeleteListener(org.forgerock.opendj.ldap.DN dn,
                            org.forgerock.opendj.config.server.spi.ConfigDeleteListener listener)

Specified by:

deregisterDeleteListener in interface org.forgerock.opendj.config.server.spi.ConfigurationRepository

deregisterChangeListener

public boolean deregisterChangeListener(org.forgerock.opendj.ldap.DN dn,
                               org.forgerock.opendj.config.server.spi.ConfigChangeListener listener)

Specified by:

deregisterChangeListener in interface org.forgerock.opendj.config.server.spi.ConfigurationRepository

getAddListeners

public List<org.forgerock.opendj.config.server.spi.ConfigAddListener> getAddListeners(org.forgerock.opendj.ldap.DN dn)

Specified by:

getAddListeners in interface org.forgerock.opendj.config.server.spi.ConfigurationRepository

getDeleteListeners

public List<org.forgerock.opendj.config.server.spi.ConfigDeleteListener> getDeleteListeners(org.forgerock.opendj.ldap.DN dn)

Specified by:

getDeleteListeners in interface org.forgerock.opendj.config.server.spi.ConfigurationRepository

getChangeListeners

public List<org.forgerock.opendj.config.server.spi.ConfigChangeListener> getChangeListeners(org.forgerock.opendj.ldap.DN dn)

Specified by:

getChangeListeners in interface org.forgerock.opendj.config.server.spi.ConfigurationRepository