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 Monitor Provider settings. 037 * <p> 038 * Monitor Providers can be used to provide information about the 039 * state of the server or one of its components. 040 */ 041public interface MonitorProviderCfg extends Configuration { 042 043 /** 044 * Gets the configuration class associated with this Monitor Provider. 045 * 046 * @return Returns the configuration class associated with this Monitor Provider. 047 */ 048 Class<? extends MonitorProviderCfg> configurationClass(); 049 050 051 052 /** 053 * Register to be notified when this Monitor Provider is changed. 054 * 055 * @param listener 056 * The Monitor Provider configuration change listener. 057 */ 058 void addChangeListener(ConfigurationChangeListener<MonitorProviderCfg> listener); 059 060 061 062 /** 063 * Deregister an existing Monitor Provider configuration change listener. 064 * 065 * @param listener 066 * The Monitor Provider configuration change listener. 067 */ 068 void removeChangeListener(ConfigurationChangeListener<MonitorProviderCfg> listener); 069 070 071 072 /** 073 * Gets the "enabled" property. 074 * <p> 075 * Indicates whether the Monitor Provider is enabled for use. 076 * 077 * @return Returns the value of the "enabled" property. 078 */ 079 boolean isEnabled(); 080 081 082 083 /** 084 * Gets the "java-class" property. 085 * <p> 086 * Specifies the fully-qualified name of the Java class that 087 * provides the Monitor Provider implementation. 088 * 089 * @return Returns the value of the "java-class" property. 090 */ 091 String getJavaClass(); 092 093}