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