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

Methods

Modifier and Type	Method and Description
ManagedObjectDefinition<? extends RootDSEBackendCfgClient,? extends RootDSEBackendCfg>	definition() Get the configuration definition associated with this Root DSE Backend.
SortedSet<DN>	getSubordinateBaseDN() Gets the "subordinate-base-dn" property.
Boolean	isShowAllAttributes() Gets the "show-all-attributes" property.
void	setShowAllAttributes(boolean value) Sets the "show-all-attributes" property.
void	setSubordinateBaseDN(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

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 PropertyException

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:

PropertyException - If the new value is invalid.

getSubordinateBaseDN

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(Collection<DN> values)
                          throws PropertyException

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:

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