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
010     * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011     * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012     * See the License for the specific language governing permissions
013     * and limitations under the License.
014     *
015     * When distributing Covered Code, include this CDDL HEADER in each
016     * file and include the License file at
017     * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
018     * add the following below this CDDL HEADER, with the fields enclosed
019     * by brackets "[]" replaced with your own identifying information:
020     *      Portions Copyright [yyyy] [name of copyright owner]
021     *
022     * CDDL HEADER END
023     *
024     *
025     *      Copyright 2008 Sun Microsystems, Inc.
026     */
027    package org.opends.server.admin.std.server;
028    
029    
030    
031    import org.opends.server.admin.Configuration;
032    import org.opends.server.admin.server.ConfigurationChangeListener;
033    
034    
035    
036    /**
037     * A server-side interface for querying Monitor Provider settings.
038     * <p>
039     * Monitor Providers can be used to provide information about the
040     * state of the server or one of its components.
041     */
042    public interface MonitorProviderCfg extends Configuration {
043    
044      /**
045       * Gets the configuration class associated with this Monitor Provider.
046       *
047       * @return Returns the configuration class associated with this Monitor Provider.
048       */
049      Class<? extends MonitorProviderCfg> configurationClass();
050    
051    
052    
053      /**
054       * Register to be notified when this Monitor Provider is changed.
055       *
056       * @param listener
057       *          The Monitor Provider configuration change listener.
058       */
059      void addChangeListener(ConfigurationChangeListener<MonitorProviderCfg> listener);
060    
061    
062    
063      /**
064       * Deregister an existing Monitor Provider configuration change listener.
065       *
066       * @param listener
067       *          The Monitor Provider configuration change listener.
068       */
069      void removeChangeListener(ConfigurationChangeListener<MonitorProviderCfg> listener);
070    
071    
072    
073      /**
074       * Gets the "enabled" property.
075       * <p>
076       * Indicates whether the Monitor Provider is enabled for use.
077       *
078       * @return Returns the value of the "enabled" property.
079       */
080      boolean isEnabled();
081    
082    
083    
084      /**
085       * Gets the "java-class" property.
086       * <p>
087       * Specifies the fully-qualified name of the Java class that
088       * provides the Monitor Provider implementation.
089       *
090       * @return Returns the value of the "java-class" property.
091       */
092      String getJavaClass();
093    
094    }