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 */
016package org.forgerock.opendj.config;
017
018/**
019 * Configuration definition <code>TopCfgDefn</code> is the root of the
020 * configuration definition hierarchy. Every configuration has
021 * <code>TopCfgDefn</code> as a superclass.
022 * <p>
023 * The <code>TopCfgDefn</code> has no properties or relations. However, it can
024 * be used to determine all the configuration definitions currently available to
025 * the administration framework using the {@link #getAllChildren()}.
026 * <p>
027 * <b>NOTE:</b> it is not possible to retrieve I18N related information or
028 * profile information for this managed object definition. In particular, calls
029 * to the methods {@link #getSynopsis()}, {@link #getDescription()},
030 * {@link #getUserFriendlyName()}, and {@link #getUserFriendlyPluralName()} will
031 * not work.
032 */
033public final class TopCfgDefn extends AbstractManagedObjectDefinition<ConfigurationClient, Configuration> {
034
035    /** The singleton configuration definition instance. */
036    private static final TopCfgDefn INSTANCE = new TopCfgDefn();
037
038    /**
039     * Get the Top configuration definition singleton.
040     *
041     * @return Returns the Top configuration definition singleton.
042     */
043    public static TopCfgDefn getInstance() {
044        return INSTANCE;
045    }
046
047    /**
048     * Private constructor.
049     */
050    private TopCfgDefn() {
051        super("top", null);
052    }
053
054}