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

Class RootDNCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<RootDNCfgClient,RootDNCfg>

org.forgerock.opendj.server.config.meta.RootDNCfgDefn

public final class RootDNCfgDefn
extends ManagedObjectDefinition<RootDNCfgClient,RootDNCfg>

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

The Root DN configuration contains all the Root DN Users defined in the directory server. In addition, it also defines the default set of privileges that Root DN Users automatically inherit.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RootDNCfgDefn.DefaultRootPrivilegeName	Defines the set of permissable values for the "default-root-privilege-name" property.

Method Summary

Modifier and Type	Method	Description
RootDNCfgClient	createClientConfiguration(ManagedObject<? extends RootDNCfgClient> impl)	Creates a client configuration view of the provided managed object.
RootDNCfg	createServerConfiguration(ServerManagedObject<? extends RootDNCfg> impl)	Creates a server configuration view of the provided server managed object.
EnumPropertyDefinition<RootDNCfgDefn.DefaultRootPrivilegeName>	getDefaultRootPrivilegeNamePropertyDefinition()	Get the "default-root-privilege-name" property definition.
static RootDNCfgDefn	getInstance()	Get the Root DN configuration definition singleton.
InstantiableRelationDefinition<RootDNUserCfgClient,RootDNUserCfg>	getRootDNUsersRelationDefinition()	Get the "root-dn-users" relation definition.
Class<RootDNCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.

Methods inherited from class org.forgerock.opendj.config.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 RootDNCfgDefn getInstance()

Get the Root DN configuration definition singleton.

Returns:

Returns the Root DN configuration definition singleton.

createClientConfiguration

public RootDNCfgClient createClientConfiguration(ManagedObject<? extends RootDNCfgClient> 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<RootDNCfgClient,RootDNCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

public RootDNCfg createServerConfiguration(ServerManagedObject<? extends RootDNCfg> impl)

Creates a server configuration view of the provided server managed object.

Specified by:

createServerConfiguration in class ManagedObjectDefinition<RootDNCfgClient,RootDNCfg>

Parameters:

impl - The server managed object.

Returns:

Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public Class<RootDNCfg> getServerConfigurationClass()

Gets the server configuration class instance associated with this managed object definition.

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<RootDNCfgClient,RootDNCfg>

Returns:

Returns the server configuration class instance associated with this managed object definition.

getDefaultRootPrivilegeNamePropertyDefinition

public EnumPropertyDefinition<RootDNCfgDefn.DefaultRootPrivilegeName> getDefaultRootPrivilegeNamePropertyDefinition()

Get the "default-root-privilege-name" property definition.

Specifies the names of the privileges that root users will be granted by default.

Returns:

Returns the "default-root-privilege-name" property definition.

getRootDNUsersRelationDefinition

public InstantiableRelationDefinition<RootDNUserCfgClient,RootDNUserCfg> getRootDNUsersRelationDefinition()

Get the "root-dn-users" relation definition.

Returns:

Returns the "root-dn-users" relation definition.