org.opends.server.admin.std.server
Interface RootDSEBackendCfg

All Superinterfaces:
Configuration

public interface RootDSEBackendCfg
extends Configuration

A server-side interface for querying Root DSE Backend settings.

The Root DSE Backend contains the Directory Server root DSE.


Method Summary
 void addChangeListener(ConfigurationChangeListener<RootDSEBackendCfg> listener)
          Register to be notified when this Root DSE Backend is changed.
 java.lang.Class<? extends RootDSEBackendCfg> configurationClass()
          Gets the configuration class associated with this Root DSE Backend.
 java.util.SortedSet<DN> getSubordinateBaseDN()
          Gets the "subordinate-base-dn" property.
 boolean isShowAllAttributes()
          Gets the "show-all-attributes" property.
 void removeChangeListener(ConfigurationChangeListener<RootDSEBackendCfg> listener)
          Deregister an existing Root DSE Backend configuration change listener.
 
Methods inherited from interface org.opends.server.admin.Configuration
dn
 

Method Detail

configurationClass

java.lang.Class<? extends RootDSEBackendCfg> configurationClass()
Gets the configuration class associated with this Root DSE Backend.

Specified by:
configurationClass in interface Configuration
Returns:
Returns the configuration class associated with this Root DSE Backend.

addChangeListener

void addChangeListener(ConfigurationChangeListener<RootDSEBackendCfg> listener)
Register to be notified when this Root DSE Backend is changed.

Parameters:
listener - The Root DSE Backend configuration change listener.

removeChangeListener

void removeChangeListener(ConfigurationChangeListener<RootDSEBackendCfg> listener)
Deregister an existing Root DSE Backend configuration change listener.

Parameters:
listener - The Root DSE Backend configuration change listener.

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.

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 an unmodifiable set containing the values of the "subordinate-base-dn" property.