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.opends.server.admin.std.server;
027
028
029
030import org.opends.server.admin.Configuration;
031import org.opends.server.admin.server.ConfigurationChangeListener;
032
033
034
035/**
036 * A server-side interface for querying Schema Provider settings.
037 * <p>
038 * Schema Providers define the schema elements to load.
039 */
040public interface SchemaProviderCfg extends Configuration {
041
042  /**
043   * Gets the configuration class associated with this Schema Provider.
044   *
045   * @return Returns the configuration class associated with this Schema Provider.
046   */
047  Class<? extends SchemaProviderCfg> configurationClass();
048
049
050
051  /**
052   * Register to be notified when this Schema Provider is changed.
053   *
054   * @param listener
055   *          The Schema Provider configuration change listener.
056   */
057  void addChangeListener(ConfigurationChangeListener<SchemaProviderCfg> listener);
058
059
060
061  /**
062   * Deregister an existing Schema Provider configuration change listener.
063   *
064   * @param listener
065   *          The Schema Provider configuration change listener.
066   */
067  void removeChangeListener(ConfigurationChangeListener<SchemaProviderCfg> listener);
068
069
070
071  /**
072   * Gets the "enabled" property.
073   * <p>
074   * Indicates whether the Schema Provider is enabled for use.
075   *
076   * @return Returns the value of the "enabled" property.
077   */
078  boolean isEnabled();
079
080
081
082  /**
083   * Gets the "java-class" property.
084   * <p>
085   * Specifies the fully-qualified name of the Java class that
086   * provides the Schema Provider implementation.
087   *
088   * @return Returns the value of the "java-class" property.
089   */
090  String getJavaClass();
091
092}