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

Interface RootDNCfgClient

All Superinterfaces:

ConfigurationClient

public interface RootDNCfgClient
extends ConfigurationClient

A client-side interface for reading and modifying 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 Summary

Modifier and Type	Method	Description
<C extends RootDNUserCfgClient> C	createRootDNUser(ManagedObjectDefinition<C,? extends RootDNUserCfg> d, String name, Collection<PropertyException> exceptions)	Creates a new Root DN User.
ManagedObjectDefinition<? extends RootDNCfgClient,? extends RootDNCfg>	definition()	Get the configuration definition associated with this Root DN.
SortedSet<RootDNCfgDefn.DefaultRootPrivilegeName>	getDefaultRootPrivilegeName()	Gets the "default-root-privilege-name" property.
RootDNUserCfgClient	getRootDNUser(String name)	Gets the named Root DN User.
String[]	listRootDNUsers()	Lists the Root DN Users.
void	removeRootDNUser(String name)	Removes the named Root DN User.
void	setDefaultRootPrivilegeName(Collection<RootDNCfgDefn.DefaultRootPrivilegeName> values)	Sets the "default-root-privilege-name" property.

Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient

commit, properties

Method Detail

definition

ManagedObjectDefinition<? extends RootDNCfgClient,? extends RootDNCfg> definition()

Get the configuration definition associated with this Root DN.

Specified by:

definition in interface ConfigurationClient

Returns:

Returns the configuration definition associated with this Root DN.

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 the values of the "default-root-privilege-name" property.

setDefaultRootPrivilegeName

void setDefaultRootPrivilegeName(Collection<RootDNCfgDefn.DefaultRootPrivilegeName> values)
                          throws PropertyException

Sets the "default-root-privilege-name" property.

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

Parameters:

values - The values of the "default-root-privilege-name" property.

Throws:

PropertyException - If one or more of the new values are invalid.

listRootDNUsers

String[] listRootDNUsers()
                  throws ConcurrentModificationException,
                         org.forgerock.opendj.ldap.LdapException

Lists the Root DN Users.

Returns:

Returns an array containing the names of the Root DN Users.

Throws:

ConcurrentModificationException - If this Root DN has been removed from the server by another client.

org.forgerock.opendj.ldap.LdapException - If any other error occurs.

getRootDNUser

RootDNUserCfgClient getRootDNUser(String name)
                           throws DefinitionDecodingException,
                                  ManagedObjectDecodingException,
                                  ManagedObjectNotFoundException,
                                  ConcurrentModificationException,
                                  org.forgerock.opendj.ldap.LdapException

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:

DefinitionDecodingException - If the named Root DN User was found but its type could not be determined.

ManagedObjectDecodingException - If the named Root DN User was found but one or more of its properties could not be decoded.

ManagedObjectNotFoundException - If the named Root DN User was not found on the server.

ConcurrentModificationException - If this Root DN has been removed from the server by another client.

org.forgerock.opendj.ldap.LdapException - If any other error occurs.

createRootDNUser

<C extends RootDNUserCfgClient> C createRootDNUser(ManagedObjectDefinition<C,? extends RootDNUserCfg> d,
                                                   String name,
                                                   Collection<PropertyException> exceptions)
                                            throws IllegalManagedObjectNameException

Creates a new Root DN User. The new Root DN User will initially not contain any property values (including mandatory properties). Once the Root DN User has been configured it can be added to the server using the ConfigurationClient.commit() method.

Type Parameters:

C - The type of the Root DN User being created.

Parameters:

d - The definition of the Root DN User to be created.

name - The name of the new Root DN User.

exceptions - An optional collection in which to place any PropertyExceptions that occurred whilst attempting to determine the default values of the Root DN User. This argument can be null.

Returns:

Returns a new Root DN User configuration instance.

Throws:

IllegalManagedObjectNameException - If the name of the new Root DN User is invalid.

removeRootDNUser

void removeRootDNUser(String name)
               throws ManagedObjectNotFoundException,
                      OperationRejectedException,
                      ConcurrentModificationException,
                      org.forgerock.opendj.ldap.LdapException

Removes the named Root DN User.

Parameters:

name - The name of the Root DN User to remove.

Throws:

ManagedObjectNotFoundException - If the Root DN User does not exist.

OperationRejectedException - If the server refuses to remove the Root DN User due to some server-side constraint which cannot be satisfied (for example, if it is referenced by another managed object).

ConcurrentModificationException - If this Root DN has been removed from the server by another client.

org.forgerock.opendj.ldap.LdapException - If any other error occurs.