org.opends.server.admin.std.client
Interface MonitorProviderCfgClient

All Superinterfaces:
ConfigurationClient
All Known Subinterfaces:
ClientConnectionMonitorProviderCfgClient, EntryCacheMonitorProviderCfgClient, MemoryUsageMonitorProviderCfgClient, StackTraceMonitorProviderCfgClient, SystemInfoMonitorProviderCfgClient, VersionMonitorProviderCfgClient

public interface MonitorProviderCfgClient
extends ConfigurationClient

A client-side interface for reading and modifying Monitor Provider settings.

Monitor Providers can be used to provide information about the state of the server or one of its components.


Method Summary
 ManagedObjectDefinition<? extends MonitorProviderCfgClient,? extends MonitorProviderCfg> definition()
          Get the configuration definition associated with this Monitor Provider.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 java.lang.Boolean isEnabled()
          Gets the "enabled" property.
 void setEnabled(boolean value)
          Sets the "enabled" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

definition

ManagedObjectDefinition<? extends MonitorProviderCfgClient,? extends MonitorProviderCfg> definition()
Get the configuration definition associated with this Monitor Provider.

Specified by:
definition in interface ConfigurationClient
Returns:
Returns the configuration definition associated with this Monitor Provider.

isEnabled

java.lang.Boolean isEnabled()
Gets the "enabled" property.

Indicates whether the Monitor Provider is enabled for use.

Returns:
Returns the value of the "enabled" property.

setEnabled

void setEnabled(boolean value)
                throws IllegalPropertyValueException
Sets the "enabled" property.

Indicates whether the Monitor Provider is enabled for use.

Parameters:
value - The value of the "enabled" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

getJavaClass

java.lang.String getJavaClass()
Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the Monitor Provider implementation.

Returns:
Returns the value of the "java-class" property.

setJavaClass

void setJavaClass(java.lang.String value)
                  throws IllegalPropertyValueException
Sets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the Monitor Provider implementation.

Parameters:
value - The value of the "java-class" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.