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

All Superinterfaces:

AlertHandlerCfgClient, ConfigurationClient

public interface JMXAlertHandlerCfgClient
extends AlertHandlerCfgClient

A client-side interface for reading and modifying JMX Alert Handler settings.

The JMX Alert Handler is used to generate JMX notifications to alert administrators of significant events that occur within the server.

Method Summary

ManagedObjectDefinition<? extends JMXAlertHandlerCfgClient,? extends JMXAlertHandlerCfg>	definition() Get the configuration definition associated with this JMX Alert Handler.
java.lang.String	getJavaClass() Gets the "java-class" property.
void	setJavaClass(java.lang.String value) Sets the "java-class" property.

Methods inherited from interface org.opends.server.admin.std.client.AlertHandlerCfgClient

getDisabledAlertType, getEnabledAlertType, isEnabled, setDisabledAlertType, setEnabled, setEnabledAlertType

Methods inherited from interface org.opends.server.admin.ConfigurationClient

commit, properties

Method Detail

definition

ManagedObjectDefinition<? extends JMXAlertHandlerCfgClient,? extends JMXAlertHandlerCfg> definition()

Get the configuration definition associated with this JMX Alert Handler.

Specified by:

definition in interface AlertHandlerCfgClient

Specified by:

definition in interface ConfigurationClient

Returns:

Returns the configuration definition associated with this JMX Alert Handler.

getJavaClass

java.lang.String getJavaClass()

Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the JMX Alert Handler implementation.

Specified by:

getJavaClass in interface AlertHandlerCfgClient

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 JMX Alert Handler implementation.

Specified by:

setJavaClass in interface AlertHandlerCfgClient

Parameters:

value - The value of the "java-class" property.

Throws:

IllegalPropertyValueException - If the new value is invalid.