org.opends.server.core

Class RootDNConfigManager

java.lang.Object

org.opends.server.core.RootDNConfigManager

All Implemented Interfaces:

org.forgerock.opendj.config.server.ConfigurationAddListener<org.forgerock.opendj.server.config.server.RootDNUserCfg>, org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.RootDNUserCfg>, org.forgerock.opendj.config.server.ConfigurationDeleteListener<org.forgerock.opendj.server.config.server.RootDNUserCfg>

public class RootDNConfigManager
extends Object
implements org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.RootDNUserCfg>, org.forgerock.opendj.config.server.ConfigurationAddListener<org.forgerock.opendj.server.config.server.RootDNUserCfg>, org.forgerock.opendj.config.server.ConfigurationDeleteListener<org.forgerock.opendj.server.config.server.RootDNUserCfg>

This class defines a utility that will be used to manage the set of root users defined in the Directory Server. It will handle both the "cn=Root DNs,cn=config" entry itself (through the root privilege change listener), and all of its children.

Constructor Summary

Constructors

Constructor and Description
RootDNConfigManager(ServerContext serverContext) Creates a new instance of this root DN config manager.

Method Summary

Modifier and Type	Method and Description
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationAdd(org.forgerock.opendj.server.config.server.RootDNUserCfg configuration)
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationChange(org.forgerock.opendj.server.config.server.RootDNUserCfg configuration)
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationDelete(org.forgerock.opendj.server.config.server.RootDNUserCfg configuration)
Set<Privilege>	getRootPrivileges() Retrieves the set of privileges that will be granted to root users by default.
void	initializeRootDNs() Initializes all of the root users currently defined in the Directory Server configuration, as well as the set of privileges that root users will inherit by default.
boolean	isConfigurationAddAcceptable(org.forgerock.opendj.server.config.server.RootDNUserCfg configuration, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)
boolean	isConfigurationChangeAcceptable(org.forgerock.opendj.server.config.server.RootDNUserCfg configuration, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)
boolean	isConfigurationDeleteAcceptable(org.forgerock.opendj.server.config.server.RootDNUserCfg configuration, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)

Methods inherited from class java.lang.Object

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

Constructor Detail

RootDNConfigManager

public RootDNConfigManager(ServerContext serverContext)

Creates a new instance of this root DN config manager.

Parameters:

serverContext - The server context.

Method Detail

initializeRootDNs

public void initializeRootDNs()
                       throws org.forgerock.opendj.config.server.ConfigException,
                              InitializationException

Initializes all of the root users currently defined in the Directory Server configuration, as well as the set of privileges that root users will inherit by default.

Throws:

org.forgerock.opendj.config.server.ConfigException - If a configuration problem causes the identity mapper initialization process to fail.

InitializationException - If a problem occurs while initializing the identity mappers that is not related to the server configuration.

getRootPrivileges

public Set<Privilege> getRootPrivileges()

Retrieves the set of privileges that will be granted to root users by default.

Returns:

The set of privileges that will be granted to root users by default.

isConfigurationAddAcceptable

public boolean isConfigurationAddAcceptable(org.forgerock.opendj.server.config.server.RootDNUserCfg configuration,
                                            List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)

Specified by:

isConfigurationAddAcceptable in interface org.forgerock.opendj.config.server.ConfigurationAddListener<org.forgerock.opendj.server.config.server.RootDNUserCfg>

applyConfigurationAdd

public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationAdd(org.forgerock.opendj.server.config.server.RootDNUserCfg configuration)

Specified by:

applyConfigurationAdd in interface org.forgerock.opendj.config.server.ConfigurationAddListener<org.forgerock.opendj.server.config.server.RootDNUserCfg>

isConfigurationDeleteAcceptable

public boolean isConfigurationDeleteAcceptable(org.forgerock.opendj.server.config.server.RootDNUserCfg configuration,
                                               List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)

Specified by:

isConfigurationDeleteAcceptable in interface org.forgerock.opendj.config.server.ConfigurationDeleteListener<org.forgerock.opendj.server.config.server.RootDNUserCfg>

applyConfigurationDelete

public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationDelete(org.forgerock.opendj.server.config.server.RootDNUserCfg configuration)

Specified by:

applyConfigurationDelete in interface org.forgerock.opendj.config.server.ConfigurationDeleteListener<org.forgerock.opendj.server.config.server.RootDNUserCfg>

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(org.forgerock.opendj.server.config.server.RootDNUserCfg configuration,
                                               List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)

Specified by:

isConfigurationChangeAcceptable in interface org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.RootDNUserCfg>

applyConfigurationChange

public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationChange(org.forgerock.opendj.server.config.server.RootDNUserCfg configuration)

Specified by:

applyConfigurationChange in interface org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.RootDNUserCfg>