com.adventnet.nms.eventdb.tl1
Interface TL1NotificationFilter

All Superinterfaces:

java.io.Serializable

public interface TL1NotificationFilter

extends java.io.Serializable

In case you need to modify or process the raw autonomous message before converting it into an Event, you can write your own notification filters. User-defined notification filter class should implement com.adventnet.nms.eventdb.tl1.TL1NotificationFilter interface. Whenever an autonomous message is received from the agent, the applyFilter(TL1Property prop, TL1AutonomousMessage messg) will be invoked. The Notification filter you write can function in any of the following ways:

It can construct an Event object out of the autonomous message passed to it and return the Event object. In this case, the returned Event object will be passed through Event Parsers and Filters defined, if any. For constructing an Event, the information obtained from the TL1 Autonomous message can be mapped to fields of Event.

It can return the autonomous message, after modifying its properties. In this case, the returned autonomous messages will try to match against the remaining TL1 Notification Filters. If it does not match, Web NMS itself will create an Event with severity mentioned in the TL1 autonomous message code.

It can drop the autonomous message by returning null.

Using tl1notification.filters file present in /conf, you can specify the fully qualified classname of the tl1 notification filter class which Web NMS should use. A sample entry in tl1notification.filters would be:

 <FILTER
 name="test"
 classname="test.DefaultNotificationFilter"
 ALARM_CODE="**" />
 

Method Summary

java.lang.Object

applyFilter(com.adventnet.management.tl1.TL1Property prop, com.adventnet.nms.eventdb.tl1.TL1AutonomousMessage messg) The Autonomous Message is passed to this method and the returned object is added to the Event Database, if not null.

Method Detail

applyFilter

public java.lang.Object applyFilter(com.adventnet.management.tl1.TL1Property prop,
                                    com.adventnet.nms.eventdb.tl1.TL1AutonomousMessage messg)

The Autonomous Message is passed to this method and the returned object is added to the Event Database, if not null.

Parameters:

prop - TL1Property instance - contains information about the device like name of the device, port number on which the TL1 agent is listening on the device

messg - Autonomous Message - contains an Autonomous ID field that identifies the the severity and nature of the autonomous message. It contains alarm code for severity

Returns:

Returns an Event or the modified AutonomousMessage object or null.