Package org.forgerock.opendj.server.config.meta

Class RootDseBackendCfgDefn

java.lang.Object

org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>

org.forgerock.opendj.config.ManagedObjectDefinition<RootDseBackendCfgClient,RootDseBackendCfg>

org.forgerock.opendj.server.config.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

Modifier and Type	Method	Description
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.
Class<RootDseBackendCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.
BooleanPropertyDefinition	getShowAllAttributesPropertyDefinition()	Get the "show-all-attributes" property definition.
BooleanPropertyDefinition	getShowSubordinateNamingContextsPropertyDefinition()	Get the "show-subordinate-naming-contexts" property definition.

Methods inherited from class org.forgerock.opendj.config.AbstractManagedObjectDefinition

getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDeprecated, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerDeprecated, 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 Details

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)

Description copied from class: ManagedObjectDefinition

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)

Description copied from class: ManagedObjectDefinition

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 Class<RootDseBackendCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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.

getShowSubordinateNamingContextsPropertyDefinition

public BooleanPropertyDefinition getShowSubordinateNamingContextsPropertyDefinition()

Get the "show-subordinate-naming-contexts" property definition.

Indicates whether subordinate naming contexts should be visible in the namingContexts attribute of the RootDSE. By default only top level naming contexts are visible

Returns:

Returns the "show-subordinate-naming-contexts" property definition.