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

All Superinterfaces:
ConfigurationClient

public interface RootDSEBackendCfgClient
extends ConfigurationClient

A client-side interface for reading and modifying Root DSE Backend settings.

The Root DSE Backend contains the Directory Server root DSE.


Method Summary
 ManagedObjectDefinition<? extends RootDSEBackendCfgClient,? extends RootDSEBackendCfg> definition()
          Get the configuration definition associated with this Root DSE Backend.
 java.util.SortedSet<DN> getSubordinateBaseDN()
          Gets the "subordinate-base-dn" property.
 java.lang.Boolean isShowAllAttributes()
          Gets the "show-all-attributes" property.
 void setShowAllAttributes(boolean value)
          Sets the "show-all-attributes" property.
 void setSubordinateBaseDN(java.util.Collection<DN> values)
          Sets the "subordinate-base-dn" property.
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

definition

ManagedObjectDefinition<? extends RootDSEBackendCfgClient,? extends RootDSEBackendCfg> definition()
Get the configuration definition associated with this Root DSE Backend.

Specified by:
definition in interface ConfigurationClient
Returns:
Returns the configuration definition associated with this Root DSE Backend.

isShowAllAttributes

java.lang.Boolean isShowAllAttributes()
Gets the "show-all-attributes" property.

Indicates whether all attributes in the root DSE are to be treated like user attributes (and therefore returned to clients by default) regardless of the Directory Server schema configuration.

Returns:
Returns the value of the "show-all-attributes" property.

setShowAllAttributes

void setShowAllAttributes(boolean value)
                          throws IllegalPropertyValueException
Sets the "show-all-attributes" property.

Indicates whether all attributes in the root DSE are to be treated like user attributes (and therefore returned to clients by default) regardless of the Directory Server schema configuration.

Parameters:
value - The value of the "show-all-attributes" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

getSubordinateBaseDN

java.util.SortedSet<DN> getSubordinateBaseDN()
Gets the "subordinate-base-dn" property.

Specifies the set of base DNs used for singleLevel, wholeSubtree, and subordinateSubtree searches based at the root DSE.

Returns:
Returns the values of the "subordinate-base-dn" property.

setSubordinateBaseDN

void setSubordinateBaseDN(java.util.Collection<DN> values)
                          throws IllegalPropertyValueException
Sets the "subordinate-base-dn" property.

Specifies the set of base DNs used for singleLevel, wholeSubtree, and subordinateSubtree searches based at the root DSE.

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