Package org.forgerock.opendj.server.config.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

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends JmxAlertHandlerCfgClient,? extends JmxAlertHandlerCfg>	definition()	Get the configuration definition associated with this JMX Alert Handler.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.

Methods inherited from interface org.forgerock.opendj.server.config.client.AlertHandlerCfgClient

getDisabledAlertType, getEnabledAlertType, isEnabled, setDisabledAlertType, setEnabled, setEnabledAlertType

Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient

commit, properties

Method Details

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

@MandatoryProperty
ValueOrExpression<String> getJavaClass()

Gets the "java-class" property.

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

Default value: org.opends.server.extensions.JMXAlertHandler

Specified by:

getJavaClass in interface AlertHandlerCfgClient

Returns:

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

setJavaClass

@MandatoryProperty
void setJavaClass(ValueOrExpression<String> value)
           throws PropertyException

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:

PropertyException - If the new value is invalid.