org.opennms.bb.eui.operator.utils.datablocks
Class EventBlock

java.lang.Object
  |
  +--org.opennms.bb.eui.operator.utils.datablocks.EventBlock

public class EventBlock
extends Object

EventBlock holds information read from an .. block in the incoming event stream

Author:
Sowmya, OpenNMS.org

Field Summary
 Vector m_autoAction
          automatic action to be taken when this event occurs
 String m_descr
          Textual description for the event
 EventHeader m_eventHeader
          The header of the event
 Hashtable m_eventParms
          Parms for the event
 Vector m_forward
          The forwarding detination of this event, the state of the forwarding detination and the mechanism to be used to forward(snmpudp/snmptcp/xmltcp/xmludp)
 String m_host
          IP address or hostname of event generator from the SNMP packet
 boolean m_insertedIntoDB
          Flag indicating if this block has been added to the database
 Vector m_logGroup
          log group to which this event belongs
 String m_logMsg
          Format of event in the event browser Also specifies if logMsg is to be suppressed/logged only/loggd and displayed etc.
 String m_logType
          log type to which this event belongs
 String m_mouseOverText
          The text to show when the mouse is over this event in the event browser
 Vector m_notification
          The notification system to forward this event to
 Vector m_operAction
          Action to be taken by the operator when this event occurs and the text seen by the operator(which when clicked will need to carry out the 'operaction'
 String m_operInstr
          Instruction for the operator
 String m_severity
          Severity of the event
 String m_snmpHost
          IP address or hostname of event generator from the IP packet
 EventSnmpInfo m_snmpInfo
          SNMP info
 String m_source
          The source from whihc the event arrives
 int m_status
          A status whose bits indicates the elements whose values are not taken from the event.conf
 Date m_time
          Time at which the event occured
 String m_tticket
          The trouble ticket system to which this event is to be forwarded to and the trouble ticket system state
 String m_uei
          The Universal Event Identifier
static int SET_AUTOACTION
           
static int SET_DESCR
           
static int SET_FORWARD
           
static int SET_LOGGROUP
           
static int SET_LOGMSG
           
static int SET_MOUSEOVERTEXT
           
static int SET_NOTIFICATION
           
static int SET_OPERACTION
           
static int SET_OPERINSTR
           
static int SET_SEVERITY
           
static int SET_SNMP
           
static int SET_TTICKET
           
static int SET_UEI
          masks for each of the eventblock element that retains the incoming value - i.e.
 
Constructor Summary
EventBlock(String uei, String source, Date time, String host, String snmpHost, EventSnmpInfo snmpInfo, Hashtable parms, String descr, String logMsg, String severity, String operInstr, Vector autoAction, Vector operAction, Vector logGrp, String logType, Vector notification, String tticket, Vector forward, String mouseText, EventHeader eventHeader)
          Constructs an EventBlock NOTE that an 'EventBlock' when created after a parse, gets constructed with only those values for the event that are different from the 'event.conf' - the flags are set to indicate these elements of the eventblock
 
Method Summary
 void addStatus(int s)
          Adds the passed status to the status of the event block
 String toString()
           
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, wait, wait, wait
 

Field Detail

SET_UEI

public static final int SET_UEI
masks for each of the eventblock element that retains the incoming value - i.e. the incoming value overrides the value in 'event.conf'

SET_SNMP

public static final int SET_SNMP

SET_DESCR

public static final int SET_DESCR

SET_LOGMSG

public static final int SET_LOGMSG

SET_SEVERITY

public static final int SET_SEVERITY

SET_OPERINSTR

public static final int SET_OPERINSTR

SET_AUTOACTION

public static final int SET_AUTOACTION

SET_OPERACTION

public static final int SET_OPERACTION

SET_LOGGROUP

public static final int SET_LOGGROUP

SET_NOTIFICATION

public static final int SET_NOTIFICATION

SET_TTICKET

public static final int SET_TTICKET

SET_FORWARD

public static final int SET_FORWARD

SET_MOUSEOVERTEXT

public static final int SET_MOUSEOVERTEXT

m_status

public int m_status
A status whose bits indicates the elements whose values are not taken from the event.conf

m_insertedIntoDB

public boolean m_insertedIntoDB
Flag indicating if this block has been added to the database

m_uei

public String m_uei
The Universal Event Identifier

m_source

public String m_source
The source from whihc the event arrives

m_time

public Date m_time
Time at which the event occured

m_host

public String m_host
IP address or hostname of event generator from the SNMP packet

m_snmpHost

public String m_snmpHost
IP address or hostname of event generator from the IP packet

m_snmpInfo

public EventSnmpInfo m_snmpInfo
SNMP info

m_eventParms

public Hashtable m_eventParms
Parms for the event

m_descr

public String m_descr
Textual description for the event

m_logMsg

public String m_logMsg
Format of event in the event browser Also specifies if logMsg is to be suppressed/logged only/loggd and displayed etc.

m_severity

public String m_severity
Severity of the event

m_operInstr

public String m_operInstr
Instruction for the operator

m_autoAction

public Vector m_autoAction
automatic action to be taken when this event occurs

m_operAction

public Vector m_operAction
Action to be taken by the operator when this event occurs and the text seen by the operator(which when clicked will need to carry out the 'operaction'

m_logGroup

public Vector m_logGroup
log group to which this event belongs

m_logType

public String m_logType
log type to which this event belongs

m_notification

public Vector m_notification
The notification system to forward this event to

m_tticket

public String m_tticket
The trouble ticket system to which this event is to be forwarded to and the trouble ticket system state

m_forward

public Vector m_forward
The forwarding detination of this event, the state of the forwarding detination and the mechanism to be used to forward(snmpudp/snmptcp/xmltcp/xmludp)

m_mouseOverText

public String m_mouseOverText
The text to show when the mouse is over this event in the event browser

m_eventHeader

public EventHeader m_eventHeader
The header of the event
Constructor Detail

EventBlock

public EventBlock(String uei,
                  String source,
                  Date time,
                  String host,
                  String snmpHost,
                  EventSnmpInfo snmpInfo,
                  Hashtable parms,
                  String descr,
                  String logMsg,
                  String severity,
                  String operInstr,
                  Vector autoAction,
                  Vector operAction,
                  Vector logGrp,
                  String logType,
                  Vector notification,
                  String tticket,
                  Vector forward,
                  String mouseText,
                  EventHeader eventHeader)
Constructs an EventBlock NOTE that an 'EventBlock' when created after a parse, gets constructed with only those values for the event that are different from the 'event.conf' - the flags are set to indicate these elements of the eventblock
Method Detail

addStatus

public void addStatus(int s)
Adds the passed status to the status of the event block
Parameters:
s - status that indcates status bits to be set

toString

public String toString()
Overrides:
toString in class Object