org.openspaces.admin.internal.alert

Class DefaultAlertManager

java.lang.Object

org.openspaces.admin.internal.alert.DefaultAlertManager

All Implemented Interfaces:

AdminAware, AlertManager, InternalAlertManager

public class DefaultAlertManager
extends Object
implements InternalAlertManager

Constructor Summary

Constructors

Constructor and Description
DefaultAlertManager(Admin admin)

Method Summary

Modifier and Type	Method and Description
void	configure(AlertConfiguration... configurations) Define an alert configuration for a 'bulk' of configurations.
void	disableAlert(Class<? extends AlertConfiguration> clazz) Disables a previously enabled alert.
void	enableAlert(Class<? extends AlertConfiguration> clazz) Enable a previously set alert configuration.
Admin	getAdmin() Returns the Admin associated with this element.
AlertRepository	getAlertRepository()
AlertStatus	getAlertStatusByGroupId(String groupUid)
AlertTriggeredEventManager	getAlertTriggered()
BeanConfigPropertiesManager	getBeanConfigPropertiesManager()
<T extends AlertConfiguration> T	getConfig(Class<T> clazz) Get the currently set alert configuration.
boolean	isAlertEnabled(Class<? extends AlertConfiguration> clazz)
boolean	removeConfig(Class<? extends AlertConfiguration> clazz) Removes a previously set alert configuration.
void	setConfig(AlertConfiguration config) Defines an alert configuration.
void	triggerAlert(Alert alert) Trigger an alert event for registered alert event listeners.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultAlertManager

public DefaultAlertManager(Admin admin)

Method Detail

getAlertRepository

public AlertRepository getAlertRepository()

Specified by:

getAlertRepository in interface InternalAlertManager

getAlertTriggered

public AlertTriggeredEventManager getAlertTriggered()

Specified by:

getAlertTriggered in interface AlertManager

Returns:

the alert event manager to register/unregister for alert events.

getAlertStatusByGroupId

public AlertStatus getAlertStatusByGroupId(String groupUid)

Specified by:

getAlertStatusByGroupId in interface AlertManager

Parameters:

groupUid - The group unique identifier

Returns:

the status of the alerts in this group

triggerAlert

public void triggerAlert(Alert alert)

Description copied from interface: AlertManager

Trigger an alert event for registered alert event listeners.

Specified by:

triggerAlert in interface AlertManager

Parameters:

alert - an alert.

getAdmin

public Admin getAdmin()

Description copied from interface: AdminAware

Returns the Admin associated with this element.

Specified by:

getAdmin in interface AdminAware

getBeanConfigPropertiesManager

public BeanConfigPropertiesManager getBeanConfigPropertiesManager()

Specified by:

getBeanConfigPropertiesManager in interface InternalAlertManager

Returns:

the weakly typed configuration API.

disableAlert

public void disableAlert(Class<? extends AlertConfiguration> clazz)
                  throws AlertConfigurationException

Description copied from interface: AlertManager

Disables a previously enabled alert. The configuration remains, but alerts will no longer be triggered. The alert can be enabled at a later time, based on previously set configuration.

If the alert is already disabled, the request is silently ignored.

Specified by:

disableAlert in interface AlertManager

Parameters:

clazz - the class of the alert configuration

Throws:

AlertConfigurationException - if the alert configuration was not previously set.

enableAlert

public void enableAlert(Class<? extends AlertConfiguration> clazz)
                 throws AlertConfigurationException

Description copied from interface: AlertManager

Enable a previously set alert configuration. From this point, alerts will be triggered.

If the alert is already enabled, the request is silently ignored.

Specified by:

enableAlert in interface AlertManager

Parameters:

clazz - the class of the alert configuration

Throws:

AlertConfigurationException - if the alert can't be enabled for any of the following reasons:

• if the configuration was not previously set.
• in the event of misconfiguration (such as failure to set an essential property).
• if initialization fails.

getConfig

public <T extends AlertConfiguration> T getConfig(Class<T> clazz)
                                           throws AlertConfigurationException

Description copied from interface: AlertManager

Get the currently set alert configuration.

Specified by:

getConfig in interface AlertManager

Parameters:

clazz - the class of the alert configuration

Returns:

The alert configuration implementation object set with the configuration properties.

Throws:

AlertConfigurationException - if the alert configuration was not previously set.

removeConfig

public boolean removeConfig(Class<? extends AlertConfiguration> clazz)
                     throws AlertConfigurationException

Description copied from interface: AlertManager

Removes a previously set alert configuration.

An exception is raised if the alert is currently enabled. Disable the alert prior to this call.

Specified by:

removeConfig in interface AlertManager

Parameters:

clazz - the class of the alert configuration

Returns:

true if removed ,false if it did not exist in the first place.

Throws:

AlertConfigurationException - if the alert configuration can't be removed for any of the following reasons:

• if the alert is currently enabled (need to disable it first).
• if the configuration was not previously set

setConfig

public void setConfig(AlertConfiguration config)
               throws AlertConfigurationException

Description copied from interface: AlertManager

Defines an alert configuration. Overrides all previously set properties for this alert.

The AlertConfiguration.isEnabled() is ignored. To enable, call AlertManager.enableAlert(Class). To perform both operations in a single call, use AlertManager.configure(AlertConfiguration[]).

An exception is raised if the alert is already enabled.

Specified by:

setConfig in interface AlertManager

Parameters:

config - the alert configuration

Throws:

AlertConfigurationException - if the alert is already enabled (need to disable it first).

isAlertEnabled

public boolean isAlertEnabled(Class<? extends AlertConfiguration> clazz)

Specified by:

isAlertEnabled in interface AlertManager

Parameters:

clazz - the class of the alert configuration

Returns:

true if the alert is already enabled, false if the alert is disabled or if it's configuration was not found.

configure

public void configure(AlertConfiguration... configurations)
               throws AlertConfigurationException

Description copied from interface: AlertManager

Define an alert configuration for a 'bulk' of configurations. Overrides all previously set properties for any of the alerts.

See the XmlAlertConfigurationParser which can be used to parse the default alerts.xml configuration file located under config/alerts.

If AlertConfiguration.isEnabled() returns true it is equivalent to calling (for a predefined alert) AlertManager.disableAlert(Class), followed by AlertManager.setConfig(AlertConfiguration) followed by AlertManager.enableAlert(Class).

If it returns false it is equivalent to calling (for a predefined alert) AlertManager.disableAlert(Class) followed by AlertManager.setConfig(AlertConfiguration).

if an alert configuration was not previously set, the current setting will be used.

Specified by:

configure in interface AlertManager

Parameters:

configurations - the alert configurations (as varargs).

Throws:

AlertConfigurationException - if the alert is already enabled (need to disable it first).

See Also:

AlertConfigurationParser