Package org.forgerock.opendj.server.config.server

Interface RootDNCfg

  • All Superinterfaces:
    Configuration
    public interface RootDNCfg
extends Configuration
    A server-side interface for querying Root DN settings.

    The Root DN configuration contains all the Root DN Users defined in the directory server. In addition, it also defines the default set of privileges that Root DN Users automatically inherit.

    • Method Detail

      • configurationClass

        Class<? extends RootDNCfg> configurationClass()
        Gets the configuration class associated with this Root DN.
        Specified by:
        configurationClass in interface Configuration
        Returns:
        Returns the configuration class associated with this Root DN.

      • addChangeListener

        void addChangeListener​(ConfigurationChangeListener<RootDNCfg> listener)
        Register to be notified when this Root DN is changed.
        Parameters:
        listener - The Root DN configuration change listener.

      • removeChangeListener

        void removeChangeListener​(ConfigurationChangeListener<RootDNCfg> listener)
        Deregister an existing Root DN configuration change listener.
        Parameters:
        listener - The Root DN configuration change listener.

      • getDefaultRootPrivilegeName

        SortedSet<RootDNCfgDefn.DefaultRootPrivilegeName> getDefaultRootPrivilegeName()
        Gets the "default-root-privilege-name" property.

        Specifies the names of the privileges that root users will be granted by default.

        Returns:
        Returns an unmodifiable set containing the values of the "default-root-privilege-name" property.

      • listRootDNUsers

        String[] listRootDNUsers()
        Lists the Root DN Users.
        Returns:
        Returns an array containing the names of the Root DN Users.

      • getRootDNUser

        RootDNUserCfg getRootDNUser​(String name)
                     throws ConfigException
        Gets the named Root DN User.
        Parameters:
        name - The name of the Root DN User to retrieve.
        Returns:
        Returns the named Root DN User.
        Throws:
        ConfigException - If the Root DN User could not be found or it could not be successfully decoded.

      • removeRootDNUserAddListener

        void removeRootDNUserAddListener​(ConfigurationAddListener<RootDNUserCfg> listener)
        Deregisters an existing Root DN User configuration add listener.
        Parameters:
        listener - The Root DN User configuration add listener.

      • addRootDNUserDeleteListener

        void addRootDNUserDeleteListener​(ConfigurationDeleteListener<RootDNUserCfg> listener)
                          throws ConfigException
        Registers to be notified when existing Root DN Users are deleted.
        Parameters:
        listener - The Root DN User configuration delete listener.
        Throws:
        ConfigException - If the delete listener could not be registered.

      • removeRootDNUserDeleteListener

        void removeRootDNUserDeleteListener​(ConfigurationDeleteListener<RootDNUserCfg> listener)
        Deregisters an existing Root DN User configuration delete listener.
        Parameters:
        listener - The Root DN User configuration delete listener.