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

Class RootDNUserCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<RootDNUserCfgClient,RootDNUserCfg>

org.forgerock.opendj.server.config.meta.RootDNUserCfgDefn

public final class RootDNUserCfgDefn
extends ManagedObjectDefinition<RootDNUserCfgClient,RootDNUserCfg>

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

A Root DN User are administrative users who can granted special privileges that are not available to non-root users (for example, the ability to bind to the server in lockdown mode).

Method Summary

Modifier and Type	Method	Description
RootDNUserCfgClient	createClientConfiguration(ManagedObject<? extends RootDNUserCfgClient> impl)	Creates a client configuration view of the provided managed object.
RootDNUserCfg	createServerConfiguration(ServerManagedObject<? extends RootDNUserCfg> impl)	Creates a server configuration view of the provided server managed object.
DNPropertyDefinition	getAlternateBindDNPropertyDefinition()	Get the "alternate-bind-dn" property definition.
static RootDNUserCfgDefn	getInstance()	Get the Root DN User configuration definition singleton.
Class<RootDNUserCfg>	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 RootDNUserCfgDefn getInstance()

Get the Root DN User configuration definition singleton.

Returns:

Returns the Root DN User configuration definition singleton.

createClientConfiguration

public RootDNUserCfgClient createClientConfiguration(ManagedObject<? extends RootDNUserCfgClient> 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<RootDNUserCfgClient,RootDNUserCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<RootDNUserCfgClient,RootDNUserCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<RootDNUserCfg> getServerConfigurationClass()

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<RootDNUserCfgClient,RootDNUserCfg>

Returns:

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

getAlternateBindDNPropertyDefinition

public DNPropertyDefinition getAlternateBindDNPropertyDefinition()

Get the "alternate-bind-dn" property definition.

Specifies one or more alternate DNs that can be used to bind to the server as this root user.

Returns:

Returns the "alternate-bind-dn" property definition.