001    /*
002     * CDDL HEADER START
003     *
004     * The contents of this file are subject to the terms of the
005     * Common Development and Distribution License, Version 1.0 only
006     * (the "License").  You may not use this file except in compliance
007     * with the License.
008     *
009     * You can obtain a copy of the license at
010     * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011     * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012     * See the License for the specific language governing permissions
013     * and limitations under the License.
014     *
015     * When distributing Covered Code, include this CDDL HEADER in each
016     * file and include the License file at
017     * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
018     * add the following below this CDDL HEADER, with the fields enclosed
019     * by brackets "[]" replaced with your own identifying information:
020     *      Portions Copyright [yyyy] [name of copyright owner]
021     *
022     * CDDL HEADER END
023     *
024     *
025     *      Copyright 2008 Sun Microsystems, Inc.
026     */
027    package org.opends.server.admin;
028    
029    
030    
031    /**
032     * Configuration definition <code>TopCfgDefn</code> is the root of
033     * the configuration definition hierarchy. Every configuration has
034     * <code>TopCfgDefn</code> as a superclass.
035     * <p>
036     * The <code>TopCfgDefn</code> has no properties or relations.
037     * However, it can be used to determine all the configuration
038     * definitions currently available to the administration framework
039     * using the {@link #getAllChildren()}.
040     * <p>
041     * <b>NOTE:</b> it is not possible to retrieve I18N related
042     * information or profile information for this managed object
043     * definition. In particular, calls to the methods
044     * {@link #getSynopsis()}, {@link #getDescription()},
045     * {@link #getUserFriendlyName()}, and
046     * {@link #getUserFriendlyPluralName()} will not work.
047     */
048    public final class TopCfgDefn extends
049        AbstractManagedObjectDefinition<ConfigurationClient, Configuration> {
050    
051      // The singleton configuration definition instance.
052      private static final TopCfgDefn INSTANCE = new TopCfgDefn();
053    
054    
055    
056      /**
057       * Get the Top configuration definition singleton.
058       *
059       * @return Returns the Top configuration definition singleton.
060       */
061      public static TopCfgDefn getInstance() {
062        return INSTANCE;
063      }
064    
065    
066    
067      /**
068       * Private constructor.
069       */
070      private TopCfgDefn() {
071        super("top", null);
072      }
073    
074    }