Package org.opends.server.extensions

Class JMXAlertHandler

java.lang.Object

javax.management.NotificationBroadcasterSupport

org.opends.server.extensions.JMXAlertHandler

All Implemented Interfaces:

DynamicMBean, NotificationBroadcaster, NotificationEmitter, ConfigurationChangeListener<JmxAlertHandlerCfg>, AlertHandler<JmxAlertHandlerCfg>, DirectoryServerMBean

public class JMXAlertHandler
extends NotificationBroadcasterSupport
implements AlertHandler<JmxAlertHandlerCfg>, ConfigurationChangeListener<JmxAlertHandlerCfg>, DynamicMBean, DirectoryServerMBean

This class provides an implementation of a Directory Server alert handler that will send alerts using JMX notifications.

Constructor Summary

Constructors

Constructor	Description
JMXAlertHandler()

Method Summary

Modifier and Type	Method	Description
ConfigChangeResult	applyConfigurationChange(JmxAlertHandlerCfg configuration)	Applies the configuration changes to this change listener.
void	finalizeAlertHandler()	Performs any necessary cleanup that may be necessary when this alert handler is finalized.
AlertHandlerCfg	getAlertHandlerConfiguration()	Retrieves the current configuration for this alert handler.
Attribute	getAttribute(String attribute)
AttributeList	getAttributes(String[] attributes)
Dn	getConfigDn()
MBeanInfo	getMBeanInfo()
MBeanNotificationInfo[]	getNotificationInfo()	Retrieves information about the types of JMX notifications that may be generated.
ObjectName	getObjectName()	Retrieves the JMX object name for this JMX alert handler.
void	initializeAlertHandler(ServerContext serverContext, JmxAlertHandlerCfg configuration)	Initializes this alert handler based on the information in the provided configuration entry.
Object	invoke(String actionName, Object[] params, String[] signature)
boolean	isConfigurationAcceptable(JmxAlertHandlerCfg configuration, List<LocalizableMessage> unacceptableReasons)	Indicates whether the provided configuration is acceptable for this alert handler.
boolean	isConfigurationChangeAcceptable(JmxAlertHandlerCfg configuration, List<LocalizableMessage> unacceptableReasons)	Indicates whether the proposed change to the configuration is acceptable to this change listener.
void	sendAlertNotification(AlertGenerator generator, String alertType, LocalizableMessage alertMessage)	Sends an alert notification based on the provided information.
void	setAttribute(Attribute attribute)
AttributeList	setAttributes(AttributeList attributes)

Methods inherited from class javax.management.NotificationBroadcasterSupport

addNotificationListener, handleNotification, removeNotificationListener, removeNotificationListener, sendNotification

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JMXAlertHandler

public JMXAlertHandler()

Method Detail

initializeAlertHandler

public void initializeAlertHandler(ServerContext serverContext,
                                   JmxAlertHandlerCfg configuration)
                            throws InitializationException

Description copied from interface: AlertHandler

Initializes this alert handler based on the information in the provided configuration entry.

Specified by:

initializeAlertHandler in interface AlertHandler<JmxAlertHandlerCfg>

Parameters:

serverContext - The server context

configuration - The configuration to use to initialize this alert handler.

Throws:

InitializationException - If a problem occurs during initialization that is not related to the server configuration.

getAlertHandlerConfiguration

public AlertHandlerCfg getAlertHandlerConfiguration()

Description copied from interface: AlertHandler

Retrieves the current configuration for this alert handler.

Specified by:

getAlertHandlerConfiguration in interface AlertHandler<JmxAlertHandlerCfg>

Returns:

The current configuration for this alert handler.

finalizeAlertHandler

public void finalizeAlertHandler()

Description copied from interface: AlertHandler

Performs any necessary cleanup that may be necessary when this alert handler is finalized.

Specified by:

finalizeAlertHandler in interface AlertHandler<JmxAlertHandlerCfg>

getObjectName

public ObjectName getObjectName()

Retrieves the JMX object name for this JMX alert handler.

Specified by:

getObjectName in interface DirectoryServerMBean

Returns:

The JMX object name for this JMX alert handler.

sendAlertNotification

public void sendAlertNotification(AlertGenerator generator,
                                  String alertType,
                                  LocalizableMessage alertMessage)

Description copied from interface: AlertHandler

Sends an alert notification based on the provided information.

Specified by:

sendAlertNotification in interface AlertHandler<JmxAlertHandlerCfg>

Parameters:

generator - The alert generator that created the alert.

alertType - The alert type name for this alert.

alertMessage - A message (possibly null) that can provide more information about this alert.

getNotificationInfo

public MBeanNotificationInfo[] getNotificationInfo()

Retrieves information about the types of JMX notifications that may be generated.

Specified by:

getNotificationInfo in interface NotificationBroadcaster

Overrides:

getNotificationInfo in class NotificationBroadcasterSupport

Returns:

Information about the types of JMX notifications that may be generated.

getAttribute

public Attribute getAttribute(String attribute)
                       throws AttributeNotFoundException

Specified by:

getAttribute in interface DynamicMBean

Throws:

AttributeNotFoundException

setAttribute

public void setAttribute(Attribute attribute)
                  throws AttributeNotFoundException

Specified by:

setAttribute in interface DynamicMBean

Throws:

AttributeNotFoundException

getAttributes

public AttributeList getAttributes(String[] attributes)

Specified by:

getAttributes in interface DynamicMBean

setAttributes

public AttributeList setAttributes(AttributeList attributes)

Specified by:

setAttributes in interface DynamicMBean

invoke

public Object invoke(String actionName,
                     Object[] params,
                     String[] signature)
              throws MBeanException

Specified by:

invoke in interface DynamicMBean

Throws:

MBeanException

getConfigDn

public Dn getConfigDn()

getMBeanInfo

public MBeanInfo getMBeanInfo()

Specified by:

getMBeanInfo in interface DynamicMBean

isConfigurationAcceptable

public boolean isConfigurationAcceptable(JmxAlertHandlerCfg configuration,
                                         List<LocalizableMessage> unacceptableReasons)

Description copied from interface: AlertHandler

Indicates whether the provided configuration is acceptable for this alert handler.

Specified by:

isConfigurationAcceptable in interface AlertHandler<JmxAlertHandlerCfg>

Parameters:

configuration - The configuration for which to make tje determination.

unacceptableReasons - A list to which human-readable reasons may be added to explain why the configuration is not acceptable.

Returns:

true if the provided configuration is acceptable, or false if it is not.

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(JmxAlertHandlerCfg configuration,
                                               List<LocalizableMessage> unacceptableReasons)

Description copied from interface: ConfigurationChangeListener

Indicates whether the proposed change to the configuration is acceptable to this change listener.

Specified by:

isConfigurationChangeAcceptable in interface ConfigurationChangeListener<JmxAlertHandlerCfg>

Parameters:

configuration - The new configuration containing the changes.

unacceptableReasons - A list that can be used to hold messages about why the provided configuration is not acceptable.

Returns:

Returns true if the proposed change is acceptable, or false if it is not.

applyConfigurationChange

public ConfigChangeResult applyConfigurationChange(JmxAlertHandlerCfg configuration)

Description copied from interface: ConfigurationChangeListener

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<JmxAlertHandlerCfg>

Parameters:

configuration - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.