com.adventnet.nms.alertdb
Interface PropagationFilter

Deprecated. As similar functionality is achieved by status propagation functionality.

public interface PropagationFilter

This interface has to be implemented by the classes that need to be intimated by NMS, when an alert gets added/updated/deleted and the corresponding Managed Object status updated accordingly. Propagation Filters are notified only when all the following three operations are completed whenever an alert related operation is performed in WebNMS.

 
 The corresponding Alert related operation like updation,addition or deletion
 should be successfully completed.
 
 Corresponding data base updation should be done.
 
 Corresponding Managed Object should be updated.
 

Managed objects are updated from Alerts, based on the value of ALERT_TO_MANAGEDOBJECT_PROPOGATION parameter which is the command line argument for EventMgr process and can be referred from NmsProcessesBE.conf file. This parameter can have any one of the following values.

 
none
 
max
 
latest
 

If it is set to none, Managed objects won't be updated through Alerts. Hence PropagationFilters will not be nofified about any alert related operations since Managed Objects are not updated by Alerts.

If it is set to max, Managed object reflects the criticality of the Alert which is having the maximim severity. Propagation Filters are notified only when the corresponding alert(i.e on which the operation is performed) updates the Managed object. Otherwise Propagation Filters will not be notified.

If it is set to latest, Managed object reflects the criticality of the latest Alert. Hence there is a chance of Managed object updation, for each and every alert operation. If the Managed Object is updated, Propagation filters will be notified.

Propagation filters are notified by the invocation of applyPropagation(MiniAlert alert) method. MiniAlert object which contains the important properties of Alert object is passed as an argument to that method.

The fully qualified names of the classes which implement these interface should be mentioned in the propagation.filters file presents in the WebNMS/conf directory, and the classes should be in classpath when NMS starts up. NMS instantiates this class on startup and invocates the method applyPropagation(MiniAlert alt) every time an alert is added/updated/deleted in NMS.

For example the following entry can be given propagation.filters file.

    <FILTER className="test.testPropagationFilter" />   
 

If the user thinks that the informations provided by MiniAlert object passed through the method applyPropagation(MiniAlert alt) are not enough, then user can specify the extended Class which has to be passed on to the applyPropagation(MiniAlert minialert) method implemented in the filter classes. The class should extend MiniAlert. This class will be instantiated by WebNMS using the constructor whose only argument is an Alert object. Hence its is mandatory for the extended class to have a constructor which receives Alert object as the only argument. This constructor will be passed the Alert object which was added/updated/deleted in NMS, so that the user can retain the values of the needed properties of Alert object within the created instance of the extended class. This extended class should be mentioned in this file with the tag <EXTENDED-CLASS>. An example format would be as follows

           <EXTENDED-CLASS className="test.extendedClass" />
 

Note: Implementation class of this interface will be used only in the BE Server JVM.

See Also:

AlertListener, AlertFilter

Method Summary

void	applyPropagation(com.adventnet.nms.alertdb.MiniAlert miniAlert) Deprecated. This method will be invoked whenever NMS adds/updates/deletes an Alert.

Method Detail

applyPropagation

void applyPropagation(com.adventnet.nms.alertdb.MiniAlert miniAlert)

Deprecated.

This method will be invoked whenever NMS adds/updates/deletes an Alert. An instance of the class MiniAlert will be passed to this method .

The miniAlert object will contain the properties entity, source, id and severity of the Alert that has been added/updated/deleted in NMS. In case, when an alert has been deleted, then the severity of the miniAlert will be the value of SpecialPurposeSeverity which can be obtained by SeverityInfo.getSpecialPurposeSeverity() method.

Parameters:

miniAlert - Object which is used for notifying Propagation filters.

See Also:

MiniAlert