org.opends.server.admin.std.client
Interface RootDNUserCfgClient

All Superinterfaces:
ConfigurationClient

public interface RootDNUserCfgClient
extends ConfigurationClient

A client-side interface for reading and modifying Root DN User settings.

A Root DN User are administrative users who can granted special privileges that are not available to non-root users (for example, the ability to bind to the server in lockdown mode).


Method Summary
 ManagedObjectDefinition<? extends RootDNUserCfgClient,? extends RootDNUserCfg> definition()
          Get the configuration definition associated with this Root DN User.
 java.util.SortedSet<DN> getAlternateBindDN()
          Gets the "alternate-bind-dn" property.
 void setAlternateBindDN(java.util.Collection<DN> values)
          Sets the "alternate-bind-dn" property.
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

definition

ManagedObjectDefinition<? extends RootDNUserCfgClient,? extends RootDNUserCfg> definition()
Get the configuration definition associated with this Root DN User.

Specified by:
definition in interface ConfigurationClient
Returns:
Returns the configuration definition associated with this Root DN User.

getAlternateBindDN

java.util.SortedSet<DN> getAlternateBindDN()
Gets the "alternate-bind-dn" property.

Specifies one or more alternate DNs that can be used to bind to the server as this root user.

Returns:
Returns the values of the "alternate-bind-dn" property.

setAlternateBindDN

void setAlternateBindDN(java.util.Collection<DN> values)
                        throws IllegalPropertyValueException
Sets the "alternate-bind-dn" property.

Specifies one or more alternate DNs that can be used to bind to the server as this root user.

Parameters:
values - The values of the "alternate-bind-dn" property.
Throws:
IllegalPropertyValueException - If one or more of the new values are invalid.