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 legal-notices/CDDLv1_0.txt 010 * or http://forgerock.org/license/CDDLv1.0.html. 011 * See the License for the specific language governing permissions 012 * and limitations under the License. 013 * 014 * When distributing Covered Code, include this CDDL HEADER in each 015 * file and include the License file at legal-notices/CDDLv1_0.txt. 016 * If applicable, add the following below this CDDL HEADER, with the 017 * fields enclosed by brackets "[]" replaced with your own identifying 018 * information: 019 * Portions Copyright [yyyy] [name of copyright owner] 020 * 021 * CDDL HEADER END 022 * 023 * 024 * Copyright 2008 Sun Microsystems, Inc. 025 */ 026package org.forgerock.opendj.config; 027 028/** 029 * Configuration definition <code>TopCfgDefn</code> is the root of the 030 * configuration definition hierarchy. Every configuration has 031 * <code>TopCfgDefn</code> as a superclass. 032 * <p> 033 * The <code>TopCfgDefn</code> has no properties or relations. However, it can 034 * be used to determine all the configuration definitions currently available to 035 * the administration framework using the {@link #getAllChildren()}. 036 * <p> 037 * <b>NOTE:</b> it is not possible to retrieve I18N related information or 038 * profile information for this managed object definition. In particular, calls 039 * to the methods {@link #getSynopsis()}, {@link #getDescription()}, 040 * {@link #getUserFriendlyName()}, and {@link #getUserFriendlyPluralName()} will 041 * not work. 042 */ 043public final class TopCfgDefn extends AbstractManagedObjectDefinition<ConfigurationClient, Configuration> { 044 045 /** The singleton configuration definition instance. */ 046 private static final TopCfgDefn INSTANCE = new TopCfgDefn(); 047 048 /** 049 * Get the Top configuration definition singleton. 050 * 051 * @return Returns the Top configuration definition singleton. 052 */ 053 public static TopCfgDefn getInstance() { 054 return INSTANCE; 055 } 056 057 /** 058 * Private constructor. 059 */ 060 private TopCfgDefn() { 061 super("top", null); 062 } 063 064}