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.client;
017
018
019
020import org.forgerock.opendj.config.ConfigurationClient;
021import org.forgerock.opendj.config.ManagedObjectDefinition;
022import org.forgerock.opendj.config.PropertyException;
023import org.forgerock.opendj.server.config.server.MonitorProviderCfg;
024
025
026
027/**
028 * A client-side interface for reading and modifying Monitor Provider
029 * settings.
030 * <p>
031 * Monitor Providers can be used to provide information about the
032 * state of the server or one of its components.
033 */
034public interface MonitorProviderCfgClient extends ConfigurationClient {
035
036  /**
037   * Get the configuration definition associated with this Monitor Provider.
038   *
039   * @return Returns the configuration definition associated with this Monitor Provider.
040   */
041  ManagedObjectDefinition<? extends MonitorProviderCfgClient, ? extends MonitorProviderCfg> definition();
042
043
044
045  /**
046   * Gets the "enabled" property.
047   * <p>
048   * Indicates whether the Monitor Provider is enabled for use.
049   *
050   * @return Returns the value of the "enabled" property.
051   */
052  Boolean isEnabled();
053
054
055
056  /**
057   * Sets the "enabled" property.
058   * <p>
059   * Indicates whether the Monitor Provider is enabled for use.
060   *
061   * @param value The value of the "enabled" property.
062   * @throws PropertyException
063   *           If the new value is invalid.
064   */
065  void setEnabled(boolean value) throws PropertyException;
066
067
068
069  /**
070   * Gets the "java-class" property.
071   * <p>
072   * Specifies the fully-qualified name of the Java class that
073   * provides the Monitor Provider implementation.
074   *
075   * @return Returns the value of the "java-class" property.
076   */
077  String getJavaClass();
078
079
080
081  /**
082   * Sets the "java-class" property.
083   * <p>
084   * Specifies the fully-qualified name of the Java class that
085   * provides the Monitor Provider implementation.
086   *
087   * @param value The value of the "java-class" property.
088   * @throws PropertyException
089   *           If the new value is invalid.
090   */
091  void setJavaClass(String value) throws PropertyException;
092
093}