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