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.server.config.server;
017
018
019
020import org.forgerock.opendj.config.Configuration;
021import org.forgerock.opendj.config.server.ConfigurationChangeListener;
022
023
024
025/**
026 * A server-side interface for querying Monitor Provider settings.
027 * <p>
028 * Monitor Providers can be used to provide information about the
029 * state of the server or one of its components.
030 */
031public interface MonitorProviderCfg extends Configuration {
032
033  /**
034   * Gets the configuration class associated with this Monitor Provider.
035   *
036   * @return Returns the configuration class associated with this Monitor Provider.
037   */
038  Class<? extends MonitorProviderCfg> configurationClass();
039
040
041
042  /**
043   * Register to be notified when this Monitor Provider is changed.
044   *
045   * @param listener
046   *          The Monitor Provider configuration change listener.
047   */
048  void addChangeListener(ConfigurationChangeListener<MonitorProviderCfg> listener);
049
050
051
052  /**
053   * Deregister an existing Monitor Provider configuration change listener.
054   *
055   * @param listener
056   *          The Monitor Provider configuration change listener.
057   */
058  void removeChangeListener(ConfigurationChangeListener<MonitorProviderCfg> listener);
059
060
061
062  /**
063   * Gets the "enabled" property.
064   * <p>
065   * Indicates whether the Monitor Provider is enabled for use.
066   *
067   * @return Returns the value of the "enabled" property.
068   */
069  boolean isEnabled();
070
071
072
073  /**
074   * Gets the "java-class" property.
075   * <p>
076   * Specifies the fully-qualified name of the Java class that
077   * provides the Monitor Provider implementation.
078   *
079   * @return Returns the value of the "java-class" property.
080   */
081  String getJavaClass();
082
083}