com.prosyst.mprm.alert

Class AlertUtil

java.lang.Object

com.prosyst.mprm.alert.AlertUtil

All Implemented Interfaces:

Supervisable

Direct Known Subclasses:

RaiseAlertAction

public class AlertUtil
extends java.lang.Object
implements Supervisable

This is an utility class for easier raising of alerts. Bundles that wish to raise their alerts can create an isntance of this class and call its raise and pullDown methods without the care about registering a Supervisable service. Invoking the raise and pullDown methods for raising and pulling down of alerts will cause immediately refreshing of the set of alerts on the alert borad. It is responsibility to the users of this class to pull down their alerts when the problem caused the alert generation is removed.

Field Summary

Fields

Modifier and Type	Field and Description
protected Alert[]	alertArray holds the raised alerts in the form of array
protected java.util.Vector	alerts Alerts container
protected org.osgi.framework.BundleContext	bc BundleContext needed for registering as Supervisable
protected boolean	modified Flag denoting whether the set of alerts has been changed since the last getAlerts invocation.
protected org.osgi.framework.ServiceRegistration	reg service registration for Supervisable service

Constructor Summary

Constructors

Constructor and Description
AlertUtil(org.osgi.framework.BundleContext bc) Creates an instance of this class with given BundleContext

Method Summary

Modifier and Type	Method and Description
void	clearAll() Pulls down (immediately) all alerts raised by this AlertUtil
void	destroy() Called when the bundle does no longer wish to be supervised.
Alert[]	getAlerts() Implementing the Supervisable.getAelrts method
void	pullDown(Alert alert) Pulls down (immediately) an alert from the alert board.
void	raise(Alert alert) Raises (immediately) a new alert on the alert board.

Methods inherited from class java.lang.Object

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

Field Detail

alerts

protected java.util.Vector alerts

Alerts container

reg

protected org.osgi.framework.ServiceRegistration reg

service registration for Supervisable service

bc

protected org.osgi.framework.BundleContext bc

BundleContext needed for registering as Supervisable

modified

protected boolean modified

Flag denoting whether the set of alerts has been changed since the last getAlerts invocation. Used for optimizations

alertArray

protected Alert[] alertArray

holds the raised alerts in the form of array

Constructor Detail

AlertUtil

public AlertUtil(org.osgi.framework.BundleContext bc)

Creates an instance of this class with given BundleContext

Method Detail

destroy

public void destroy()

Called when the bundle does no longer wish to be supervised. Calling of this method will cause the Supervisable service to be unregistered.

raise

public void raise(Alert alert)

Raises (immediately) a new alert on the alert board.

pullDown

public void pullDown(Alert alert)

Pulls down (immediately) an alert from the alert board.

clearAll

public void clearAll()

Pulls down (immediately) all alerts raised by this AlertUtil

getAlerts

public Alert[] getAlerts()

Implementing the Supervisable.getAelrts method

Specified by:

getAlerts in interface Supervisable