org.opends.server.admin.std.meta
Class RootDSEBackendCfgDefn

java.lang.Object
  extended by org.opends.server.admin.AbstractManagedObjectDefinition<C,S>
      extended by org.opends.server.admin.ManagedObjectDefinition<RootDSEBackendCfgClient,RootDSEBackendCfg>
          extended by org.opends.server.admin.std.meta.RootDSEBackendCfgDefn

public final class RootDSEBackendCfgDefn
extends ManagedObjectDefinition<RootDSEBackendCfgClient,RootDSEBackendCfg>

An interface for querying the Root DSE Backend managed object definition meta information.

The Root DSE Backend contains the Directory Server root DSE.


Method Summary
 RootDSEBackendCfgClient createClientConfiguration(ManagedObject<? extends RootDSEBackendCfgClient> impl)
          Creates a client configuration view of the provided managed object.
 RootDSEBackendCfg createServerConfiguration(ServerManagedObject<? extends RootDSEBackendCfg> impl)
          Creates a server configuration view of the provided server managed object.
static RootDSEBackendCfgDefn getInstance()
          Get the Root DSE Backend configuration definition singleton.
 java.lang.Class<RootDSEBackendCfg> getServerConfigurationClass()
          Gets the server configuration class instance associated with this managed object definition.
 BooleanPropertyDefinition getShowAllAttributesPropertyDefinition()
          Get the "show-all-attributes" property definition.
 DNPropertyDefinition getSubordinateBaseDNPropertyDefinition()
          Get the "subordinate-base-dn" property definition.
 
Methods inherited from class org.opends.server.admin.AbstractManagedObjectDefinition
getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getInstance

public static RootDSEBackendCfgDefn getInstance()
Get the Root DSE Backend configuration definition singleton.

Returns:
Returns the Root DSE Backend configuration definition singleton.

createClientConfiguration

public RootDSEBackendCfgClient createClientConfiguration(ManagedObject<? extends RootDSEBackendCfgClient> impl)
Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.

Specified by:
createClientConfiguration in class ManagedObjectDefinition<RootDSEBackendCfgClient,RootDSEBackendCfg>
Parameters:
impl - The managed object.
Returns:
Returns a client configuration view of the provided managed object.

createServerConfiguration

public RootDSEBackendCfg createServerConfiguration(ServerManagedObject<? extends RootDSEBackendCfg> impl)
Creates a server configuration view of the provided server managed object.

Specified by:
createServerConfiguration in class ManagedObjectDefinition<RootDSEBackendCfgClient,RootDSEBackendCfg>
Parameters:
impl - The server managed object.
Returns:
Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public java.lang.Class<RootDSEBackendCfg> getServerConfigurationClass()
Gets the server configuration class instance associated with this managed object definition.

Specified by:
getServerConfigurationClass in class ManagedObjectDefinition<RootDSEBackendCfgClient,RootDSEBackendCfg>
Returns:
Returns the server configuration class instance associated with this managed object definition.

getShowAllAttributesPropertyDefinition

public BooleanPropertyDefinition getShowAllAttributesPropertyDefinition()
Get the "show-all-attributes" property definition.

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 "show-all-attributes" property definition.

getSubordinateBaseDNPropertyDefinition

public DNPropertyDefinition getSubordinateBaseDNPropertyDefinition()
Get the "subordinate-base-dn" property definition.

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

Returns:
Returns the "subordinate-base-dn" property definition.