/*
|
* CDDL HEADER START
|
*
|
* The contents of this file are subject to the terms of the
|
* Common Development and Distribution License, Version 1.0 only
|
* (the "License"). You may not use this file except in compliance
|
* with the License.
|
*
|
* You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
|
* or http://forgerock.org/license/CDDLv1.0.html.
|
* See the License for the specific language governing permissions
|
* and limitations under the License.
|
*
|
* When distributing Covered Code, include this CDDL HEADER in each
|
* file and include the License file at legal-notices/CDDLv1_0.txt.
|
* If applicable, add the following below this CDDL HEADER, with the
|
* fields enclosed by brackets "[]" replaced with your own identifying
|
* information:
|
* Portions Copyright [yyyy] [name of copyright owner]
|
*
|
* CDDL HEADER END
|
*
|
*
|
* Copyright 2008 Sun Microsystems, Inc.
|
*/
|
package org.forgerock.opendj.config;
|
|
/**
|
* Configuration definition <code>TopCfgDefn</code> is the root of the
|
* configuration definition hierarchy. Every configuration has
|
* <code>TopCfgDefn</code> as a superclass.
|
* <p>
|
* The <code>TopCfgDefn</code> has no properties or relations. However, it can
|
* be used to determine all the configuration definitions currently available to
|
* the administration framework using the {@link #getAllChildren()}.
|
* <p>
|
* <b>NOTE:</b> it is not possible to retrieve I18N related information or
|
* profile information for this managed object definition. In particular, calls
|
* to the methods {@link #getSynopsis()}, {@link #getDescription()},
|
* {@link #getUserFriendlyName()}, and {@link #getUserFriendlyPluralName()} will
|
* not work.
|
*/
|
public final class TopCfgDefn extends AbstractManagedObjectDefinition<ConfigurationClient, Configuration> {
|
|
/** The singleton configuration definition instance. */
|
private static final TopCfgDefn INSTANCE = new TopCfgDefn();
|
|
/**
|
* Get the Top configuration definition singleton.
|
*
|
* @return Returns the Top configuration definition singleton.
|
*/
|
public static TopCfgDefn getInstance() {
|
return INSTANCE;
|
}
|
|
/**
|
* Private constructor.
|
*/
|
private TopCfgDefn() {
|
super("top", null);
|
}
|
|
}
|
