Package org.forgerock.opendj.server.config.server

Interface JmxAlertHandlerCfg

All Superinterfaces:

AlertHandlerCfg, Configuration

public interface JmxAlertHandlerCfg
extends AlertHandlerCfg

A server-side interface for querying 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
void	addJmxChangeListener(ConfigurationChangeListener<JmxAlertHandlerCfg> listener)	Register to be notified when this JMX Alert Handler is changed.
Class<? extends JmxAlertHandlerCfg>	configurationClass()	Gets the configuration class associated with this JMX Alert Handler.
String	getJavaClass()	Gets the "java-class" property.
void	removeJmxChangeListener(ConfigurationChangeListener<JmxAlertHandlerCfg> listener)	Deregister an existing JMX Alert Handler configuration change listener.

Methods inherited from interface org.forgerock.opendj.server.config.server.AlertHandlerCfg

addChangeListener, getDisabledAlertType, getEnabledAlertType, isEnabled, removeChangeListener

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

dn, name

Method Details

configurationClass

Class<? extends JmxAlertHandlerCfg> configurationClass()

Gets the configuration class associated with this JMX Alert Handler.

Specified by:

configurationClass in interface AlertHandlerCfg

Specified by:

configurationClass in interface Configuration

Returns:

Returns the configuration class associated with this JMX Alert Handler.

addJmxChangeListener

void addJmxChangeListener(ConfigurationChangeListener<JmxAlertHandlerCfg> listener)

Register to be notified when this JMX Alert Handler is changed.

Parameters:

listener - The JMX Alert Handler configuration change listener.

removeJmxChangeListener

void removeJmxChangeListener(ConfigurationChangeListener<JmxAlertHandlerCfg> listener)

Deregister an existing JMX Alert Handler configuration change listener.

Parameters:

listener - The JMX Alert Handler configuration change listener.

getJavaClass

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 AlertHandlerCfg

Returns:

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