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.server.ConfigurationChangeListener;
021
022
023
024/**
025 * A server-side interface for querying System Info Monitor Provider
026 * settings.
027 * <p>
028 * The System Info Monitor Provider can be used to publish information
029 * about the system and virtual machine on which the directory server
030 * is running.
031 */
032public interface SystemInfoMonitorProviderCfg extends MonitorProviderCfg {
033
034  /**
035   * Gets the configuration class associated with this System Info Monitor Provider.
036   *
037   * @return Returns the configuration class associated with this System Info Monitor Provider.
038   */
039  Class<? extends SystemInfoMonitorProviderCfg> configurationClass();
040
041
042
043  /**
044   * Register to be notified when this System Info Monitor Provider is changed.
045   *
046   * @param listener
047   *          The System Info Monitor Provider configuration change listener.
048   */
049  void addSystemInfoChangeListener(ConfigurationChangeListener<SystemInfoMonitorProviderCfg> listener);
050
051
052
053  /**
054   * Deregister an existing System Info Monitor Provider configuration change listener.
055   *
056   * @param listener
057   *          The System Info Monitor Provider configuration change listener.
058   */
059  void removeSystemInfoChangeListener(ConfigurationChangeListener<SystemInfoMonitorProviderCfg> listener);
060
061
062
063  /**
064   * Gets the "java-class" property.
065   * <p>
066   * Specifies the fully-qualified name of the Java class that
067   * provides the System Info Monitor Provider implementation.
068   *
069   * @return Returns the value of the "java-class" property.
070   */
071  String getJavaClass();
072
073}