Package org.opennms.netmgt.eventd.datablock

Class EventConfData

  • public class EventConfData
extends java.lang.Object
     The information read from the eventconf.xml is stored here. It maintains
  a map,  keyed with 'EventKey's.

  It also has an UEI to 'EventKey'list map - this mapping fastens the lookup
  for OpenNMS internal events when different masks are configured for the
  same UEI.

  When a lookup is to be done for an 'Event',
  - its 'key' is used to get a lookup,
  - if no match is found for the key, UEI is used to lookup the keys that got added for that UEI
    and the first best fit in the event map for any of the UEI keys are used
  - if there is still no match at this point, all keys in the eventconf are iterated through to
    find a match
    Version:
    $Id: $
    Author:
    Sowmya Nataraj , OpenNMS.org , Sowmya Nataraj , OpenNMS.org

    • Constructor Summary

      Constructors 
      Constructor Description
      EventConfData()
      Default constructor - allocate the maps

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void clear()
      Clear out the data
      static boolean eventValuePassesMaskValue​(java.lang.String eventvalue, java.util.List<java.lang.String> maskValues)
      Check whether the eventvalue passes any of the mask values Mask values ending with a '%' only need to be a substring of the eventvalue for the eventvalue to pass the mask Enhanced 2005/08/31 to allow regular expression in eventconf.
      Event getEvent​(Event event)
      Get the right configuration for the event - the eventkey is used first.
      Event getEventByUEI​(java.lang.String uei)
      Get the event with the specified uei
      void put​(EventKey key, Event event)
      Add an event with the specified key
      void put​(Event event)
      Add an event - add to the 'EventKey' map using the event mask by default.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • EventConfData

        public EventConfData()
        Default constructor - allocate the maps

    • Method Detail

      • eventValuePassesMaskValue

        public static boolean eventValuePassesMaskValue​(java.lang.String eventvalue,
                                                java.util.List<java.lang.String> maskValues)
        Check whether the eventvalue passes any of the mask values Mask values ending with a '%' only need to be a substring of the eventvalue for the eventvalue to pass the mask Enhanced 2005/08/31 to allow regular expression in eventconf.
        Parameters:
        eventvalue - a String object.
        maskValues - a List object.
        Returns:
        true if the values passes the mask

      • put

        public void put​(Event event)
        Add an event - add to the 'EventKey' map using the event mask by default. If the event has snmp information, add using the snmp EID
        Parameters:
        event - the org.opennms.netmgt.xml.eventconf.Event

      • put

        public void put​(EventKey key,
                Event event)
        Add an event with the specified key
        Parameters:
        key - the EventKey for this event
        event - the org.opennms.netmgt.xml.eventconf.Event

      • getEvent

        public Event getEvent​(Event event)
         Get the right configuration for the event - the eventkey is used first.
  If no match is found, the event's uei to keylist is iterated through, and these keys
  used to lookup the event map. if still no match is found, all eventconf
  keys are iterated through to find a match. The first successful match is returned.


 
 NOTE:
 
 The first right config event that the event matches is returned.
  The ordering of the configurations is the responsibility of the user
        Parameters:
        event - the event which is to be looked up
        Returns:
        a Event object.

      • getEventByUEI

        public Event getEventByUEI​(java.lang.String uei)
        Get the event with the specified uei
        Parameters:
        uei - the uei
        Returns:
        a Event object.

      • clear

        public void clear()
        Clear out the data