org.opends.server.admin
Class TopCfgDefn

java.lang.Object
  extended by org.opends.server.admin.AbstractManagedObjectDefinition<ConfigurationClient,Configuration>
      extended by org.opends.server.admin.TopCfgDefn

public final class TopCfgDefn
extends AbstractManagedObjectDefinition<ConfigurationClient,Configuration>

Configuration definition TopCfgDefn is the root of the configuration definition hierarchy. Every configuration has TopCfgDefn as a superclass.

The TopCfgDefn has no properties or relations. However, it can be used to determine all the configuration definitions currently available to the administration framework using the AbstractManagedObjectDefinition.getAllChildren().

NOTE: it is not possible to retrieve I18N related information or profile information for this managed object definition. In particular, calls to the methods AbstractManagedObjectDefinition.getSynopsis(), AbstractManagedObjectDefinition.getDescription(), AbstractManagedObjectDefinition.getUserFriendlyName(), and AbstractManagedObjectDefinition.getUserFriendlyPluralName() will not work.


Method Summary
static TopCfgDefn getInstance()
          Get the Top configuration definition singleton.
 
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 TopCfgDefn getInstance()
Get the Top configuration definition singleton.

Returns:
Returns the Top configuration definition singleton.