Event (OpenNMS 2021.1.1 API)

java.lang.Object
- org.opennms.web.event.Event

```
public class Event
extends Object
```
A JavaBean implementation to hold information about a network event as defined by OpenNMS.

Author:

Lawrence Karnowski , OpenNMS

Field Summary

Fields
Modifier and Type	Field and Description
`protected Date`	`acknowledgeTime` The time this event was acknowledged.
`protected String`	`acknowledgeUser` The name of the user who acknowledged this event.
`protected Integer`	`alarmId` The alarmId if reduced.
`protected String`	`autoAction` Automated Action for event.
`protected Date`	`createTime` Creation time of event in database, cannot be null
`protected String`	`description` Free-form textual description of the event
`protected String`	`dpName` The dpName of the Dist Poller which received the event, cannot be null.
`protected Boolean`	`eventDisplay` Whether the event is displayable.
`protected String`	`forward` The forwarding information.
`protected String`	`host` The <host> element from the Event Data Stream DTD
`protected int`	`id` Unique identifier for the event, cannot be null
`protected String`	`ipAddr` IP Address of node's interface
`protected String`	`location`
`protected String`	`logGroup` Logical group with which to associate event.
`protected String`	`logMessage` Formatted display text to control how the event will appear in the browser.
`protected String`	`mouseOverText` Mouse over text.
`protected Integer`	`nodeID` Unique integer identifier for node, can be null
`protected String`	`nodeLabel` The human-readable name of the node of this event.
`protected String`	`nodeLocation`
`protected String`	`notification` Notification string.
`protected String`	`operatorAction` Operator Action for event.
`protected String`	`operatorActionMenuText` Text of the eventOperAction.
`protected String`	`operatorInstruction` Operator instruction for event.
`protected Map<String,String>`	`parms` The <parms> element from the Event Data Stream DTD
`protected Integer`	`serviceID` Unique integer identifier of service/poller package, can be null
`protected String`	`serviceName` Human-readable name of the service
`protected OnmsSeverity`	`severity` Severity the of event.
`protected String`	`snmp` Contains the eid, eidtext (optionally), specific, and generic identifier for the SNMP Trap.
`protected String`	`snmphost` The <snmphost> element from the Event Data Stream DTD
`protected String`	`systemId`
`protected Date`	`time` The <time> element from the Event Data Stream DTD, which is the time the event was received by the source process.
`protected String`	`troubleTicket` Trouble ticket integration string.
`protected Integer`	`troubleTicketState` State of the trouble ticket.
`protected String`	`uei` Universal Event Identifer (UEI) for this event, cannot be null

Constructor Summary

Constructors
Constructor and Description
`Event()` Empty constructor to create an empty `Event` instance.
`Event(int id, String uei, Date time, String dpName, Date createTime, int severityId)` Create an event that represents a real network event with only the required parameters.
Event(int id, String uei, Date time, String dpName, Date createTime, int severityId, String snmp, String host, String snmphost, Map<String,String> parms, Integer nodeID, Integer serviceID, String ipAddr, String description, String logMessage, String logGroup, String operatorInstruction, String autoAction, String operatorAction, String operatorActionMenuText, String notification, String troubleTicket, Integer troubleTicketState, String forward, String mouseOverText, String acknowledgeUser, Date acknowledgeTime) Create an event that represents a real network event with all the parameters.
Event(int id, String uei, Date time, String dpName, Date createTime, int severityId, String snmp, String host, String snmphost, Map<String,String> parms, Integer nodeID, Integer serviceID, String ipAddr, String description, String logMessage, String logGroup, String operatorInstruction, String autoAction, String operatorAction, String operatorActionMenuText, String notification, String troubleTicket, Integer troubleTicketState, String forward, String mouseOverText, String acknowledgeUser, Date acknowledgeTime, String nodeLabel, String serviceName, Integer alarmId) Constructor for Event.
Event(int id, String uei, Date time, String dpName, Date createTime, int severityId, String snmp, String host, String snmphost, Map<String,String> parms, Integer nodeID, Integer serviceID, String ipAddr, String description, String logMessage, String logGroup, String operatorInstruction, String autoAction, String operatorAction, String operatorActionMenuText, String notification, String troubleTicket, Integer troubleTicketState, String forward, String mouseOverText, String acknowledgeUser, Date acknowledgeTime, String nodeLabel, String serviceName, Integer alarmId, Boolean eventDisplay) Create an event that represents a real network event with all the parameters.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Date`	`getAcknowledgeTime()` Getter for the field `acknowledgeTime`.
`String`	`getAcknowledgeUser()` Getter for the field `acknowledgeUser`.
`Integer`	`getAlarmId()` Getter for the field `alarmId`.
`String`	`getAutoAction()` Getter for the field `autoAction`.
`Date`	`getCreateTime()` Getter for the field `createTime`.
`String`	`getDescription()` Getter for the field `description`.
`String`	`getDpName()` Getter for the field `dpName`.
`Boolean`	`getEventDisplay()` Getter for the field `eventDisplay`.
`String`	`getForward()` Getter for the field `forward`.
`String`	`getHost()` Getter for the field `host`.
`int`	`getId()` Getter for the field `id`.
`String`	`getIpAddress()` getIpAddress
`String`	`getLocation()`
`String`	`getLogGroup()` Getter for the field `logGroup`.
`String`	`getLogMessage()` Getter for the field `logMessage`.
`String`	`getMouseOverText()` Getter for the field `mouseOverText`.
`int`	`getNodeId()` getNodeId
`String`	`getNodeLabel()` Getter for the field `nodeLabel`.
`String`	`getNodeLocation()`
`String`	`getNotification()` Getter for the field `notification`.
`String`	`getOperatorAction()` Getter for the field `operatorAction`.
`String`	`getOperatorActionMenuText()` Getter for the field `operatorActionMenuText`.
`String`	`getOperatorInstruction()` Getter for the field `operatorInstruction`.
`Map<String,String>`	`getParms()` Getter for the field `parms`.
`int`	`getServiceId()` getServiceId
`String`	`getServiceName()` Getter for the field `serviceName`.
`OnmsSeverity`	`getSeverity()` Getter for the field `severity`.
`String`	`getSnmp()` Getter for the field `snmp`.
`String`	`getSnmpHost()` getSnmpHost
`String`	`getSystemId()`
`Date`	`getTime()` Getter for the field `time`.
`String`	`getTroubleTicket()` Getter for the field `troubleTicket`.
`Integer`	`getTroubleTicketState()` Getter for the field `troubleTicketState`.
`String`	`getUei()` Getter for the field `uei`.
`boolean`	`isAcknowledged()` isAcknowledged

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - id
```
protected int id
```
    Unique identifier for the event, cannot be null
  - uei
```
protected String uei
```
    Universal Event Identifer (UEI) for this event, cannot be null
  - snmp
```
protected String snmp
```
    Contains the eid, eidtext (optionally), specific, and generic identifier for the SNMP Trap. This maps directly to the <snmp>element in the Event Data Stream DTD.
  - time
```
protected Date time
```
    The <time> element from the Event Data Stream DTD, which is the time the event was received by the source process. Cannot be null.
  - host
```
protected String host
```
    The <host> element from the Event Data Stream DTD
  - snmphost
```
protected String snmphost
```
    The <snmphost> element from the Event Data Stream DTD
  - dpName
```
protected String dpName
```
    The dpName of the Dist Poller which received the event, cannot be null.
  - parms
```
protected Map<String,String> parms
```
    The <parms> element from the Event Data Stream DTD
  - nodeID
```
protected Integer nodeID
```
    Unique integer identifier for node, can be null
  - serviceID
```
protected Integer serviceID
```
    Unique integer identifier of service/poller package, can be null
  - serviceName
```
protected String serviceName
```
    Human-readable name of the service
  - ipAddr
```
protected String ipAddr
```
    IP Address of node's interface
  - createTime
```
protected Date createTime
```
    Creation time of event in database, cannot be null
  - description
```
protected String description
```
    Free-form textual description of the event
  - logMessage
```
protected String logMessage
```
    Formatted display text to control how the event will appear in the browser. This field may contain variables that are populated by field values of the message.
  - logGroup
```
protected String logGroup
```
    Logical group with which to associate event. This field provides a means of logically grouping related events.
  - severity
```
protected OnmsSeverity severity
```
    Severity the of event.
```
 
   1  = Indeterminate
   2 = Cleared (unimplemented at this time)
   3 = Warning
   4 = Minor
   5 = Major
   6 = Critical
  
 
```
  - operatorInstruction
```
protected String operatorInstruction
```
    Operator instruction for event.
  - autoAction
```
protected String autoAction
```
    Automated Action for event. Should consist of fully-qualfied pathname to executable command, with possible variables used to reference event-specific data
  - operatorAction
```
protected String operatorAction
```
    Operator Action for event. Should consist of fully-qualfied pathname to executable command, with possible variables used to reference event-specific data
  - operatorActionMenuText
```
protected String operatorActionMenuText
```
    Text of the eventOperAction. Menu text displayed to Operator, which if selected, will invoke action described in eventOperAction.
  - notification
```
protected String notification
```
    Notification string. Should consist of a fully-qualfied pathname to an executable which invokes the notification software, and will likely contain event-specific variables
  - troubleTicket
```
protected String troubleTicket
```
    Trouble ticket integration string. Should consist of fully-qualfied pathname to executable command, with possible variables used to reference event-specific data
  - troubleTicketState
```
protected Integer troubleTicketState
```
    State of the trouble ticket. Trouble ticket on/off boolean 1=on, 0=off. Can be null.
  - forward
```
protected String forward
```
    The forwarding information. Contains a list of triplets: Destination,State,Mechanism;Destination,State,Mechanism; which reflect the following:
    - State is a boolean flag as to whether the entry is active or not. 1=on, 0=off.
    - Destination is hostname or IP of system to forward the event to
    - Method is the means by which it will be forwarded. A keyword, e.g., SNMP
  - mouseOverText
```
protected String mouseOverText
```
    Mouse over text. Text to be displayed on MouseOver event, if the event is displayed in the browser and the operator needs additional info.
  - acknowledgeUser
```
protected String acknowledgeUser
```
    The name of the user who acknowledged this event.
  - acknowledgeTime
```
protected Date acknowledgeTime
```
    The time this event was acknowledged.
  - nodeLabel
```
protected String nodeLabel
```
    The human-readable name of the node of this event. Can be null.
  - alarmId
```
protected Integer alarmId
```
    The alarmId if reduced. Can be null.
  - eventDisplay
```
protected Boolean eventDisplay
```
    Whether the event is displayable.
  - systemId
```
protected String systemId
```
  - location
```
protected String location
```
  - nodeLocation
```
protected String nodeLocation
```
- Constructor Detail
  - Event
```
public Event()
```
    Empty constructor to create an empty Event instance. All fields will hold the default values.
  - Event
```
public Event(int id,
             String uei,
             Date time,
             String dpName,
             Date createTime,
             int severityId)
```
    Create an event that represents a real network event with only the required parameters.
    
    Parameters:
    
    id - a int.
    
    uei - a String object.
    
    time - a Date object.
    
    dpName - a String object.
    
    createTime - a Date object.
    
    severityId - a int.
  - Event
```
public Event(int id,
             String uei,
             Date time,
             String dpName,
             Date createTime,
             int severityId,
             String snmp,
             String host,
             String snmphost,
             Map<String,String> parms,
             Integer nodeID,
             Integer serviceID,
             String ipAddr,
             String description,
             String logMessage,
             String logGroup,
             String operatorInstruction,
             String autoAction,
             String operatorAction,
             String operatorActionMenuText,
             String notification,
             String troubleTicket,
             Integer troubleTicketState,
             String forward,
             String mouseOverText,
             String acknowledgeUser,
             Date acknowledgeTime)
```
    Create an event that represents a real network event with all the parameters.
    
    Parameters:
    
    id - a int.
    
    uei - a String object.
    
    time - a Date object.
    
    dpName - a String object.
    
    createTime - a Date object.
    
    severityId - a int.
    
    snmp - a String object.
    
    host - a String object.
    
    snmphost - a String object.
    
    parms - a String object.
    
    nodeID - a Integer object.
    
    serviceID - a Integer object.
    
    ipAddr - a String object.
    
    description - a String object.
    
    logMessage - a String object.
    
    logGroup - a String object.
    
    operatorInstruction - a String object.
    
    autoAction - a String object.
    
    operatorAction - a String object.
    
    operatorActionMenuText - a String object.
    
    notification - a String object.
    
    troubleTicket - a String object.
    
    troubleTicketState - a Integer object.
    
    forward - a String object.
    
    mouseOverText - a String object.
    
    acknowledgeUser - a String object.
    
    acknowledgeTime - a Date object.
  - Event
```
public Event(int id,
             String uei,
             Date time,
             String dpName,
             Date createTime,
             int severityId,
             String snmp,
             String host,
             String snmphost,
             Map<String,String> parms,
             Integer nodeID,
             Integer serviceID,
             String ipAddr,
             String description,
             String logMessage,
             String logGroup,
             String operatorInstruction,
             String autoAction,
             String operatorAction,
             String operatorActionMenuText,
             String notification,
             String troubleTicket,
             Integer troubleTicketState,
             String forward,
             String mouseOverText,
             String acknowledgeUser,
             Date acknowledgeTime,
             String nodeLabel,
             String serviceName,
             Integer alarmId)
```
    Constructor for Event.
    
    Parameters:
    
    id - a int.
    
    uei - a String object.
    
    time - a Date object.
    
    dpName - a String object.
    
    createTime - a Date object.
    
    severityId - a int.
    
    snmp - a String object.
    
    host - a String object.
    
    snmphost - a String object.
    
    parms - a String object.
    
    nodeID - a Integer object.
    
    serviceID - a Integer object.
    
    ipAddr - a String object.
    
    description - a String object.
    
    logMessage - a String object.
    
    logGroup - a String object.
    
    operatorInstruction - a String object.
    
    autoAction - a String object.
    
    operatorAction - a String object.
    
    operatorActionMenuText - a String object.
    
    notification - a String object.
    
    troubleTicket - a String object.
    
    troubleTicketState - a Integer object.
    
    forward - a String object.
    
    mouseOverText - a String object.
    
    acknowledgeUser - a String object.
    
    acknowledgeTime - a Date object.
    
    nodeLabel - a String object.
    
    serviceName - a String object.
    
    alarmId - a Integer object.
  - Event
```
public Event(int id,
             String uei,
             Date time,
             String dpName,
             Date createTime,
             int severityId,
             String snmp,
             String host,
             String snmphost,
             Map<String,String> parms,
             Integer nodeID,
             Integer serviceID,
             String ipAddr,
             String description,
             String logMessage,
             String logGroup,
             String operatorInstruction,
             String autoAction,
             String operatorAction,
             String operatorActionMenuText,
             String notification,
             String troubleTicket,
             Integer troubleTicketState,
             String forward,
             String mouseOverText,
             String acknowledgeUser,
             Date acknowledgeTime,
             String nodeLabel,
             String serviceName,
             Integer alarmId,
             Boolean eventDisplay)
```
    Create an event that represents a real network event with all the parameters.
- Method Detail
  - getId
```
public int getId()
```
    Getter for the field id.
    
    Returns:
    
    a int.
  - getUei
```
public String getUei()
```
    Getter for the field uei.
    
    Returns:
    
    a String object.
  - getTime
```
public Date getTime()
```
    Getter for the field time.
    
    Returns:
    
    a Date object.
  - getDpName
```
public String getDpName()
```
    Getter for the field dpName.
    
    Returns:
    
    a String object.
  - getCreateTime
```
public Date getCreateTime()
```
    Getter for the field createTime.
    
    Returns:
    
    a Date object.
  - getSeverity
```
public OnmsSeverity getSeverity()
```
    Getter for the field severity.
    
    Returns:
    
    a OnmsSeverity object.
  - getSnmp
```
public String getSnmp()
```
    Getter for the field snmp.
    
    Returns:
    
    a String object.
  - getHost
```
public String getHost()
```
    Getter for the field host.
    
    Returns:
    
    a String object.
  - getSnmpHost
```
public String getSnmpHost()
```
    getSnmpHost
    
    Returns:
    
    a String object.
  - getParms
```
public Map<String,String> getParms()
```
    Getter for the field parms.
    
    Returns:
    
    a String object.
  - getNodeId
```
public int getNodeId()
```
    getNodeId
    
    Returns:
    
    a int.
  - getNodeLabel
```
public String getNodeLabel()
```
    Getter for the field nodeLabel.
    
    Returns:
    
    a String object.
  - getServiceId
```
public int getServiceId()
```
    getServiceId
    
    Returns:
    
    a int.
  - getServiceName
```
public String getServiceName()
```
    Getter for the field serviceName.
    
    Returns:
    
    a String object.
  - getIpAddress
```
public String getIpAddress()
```
    getIpAddress
    
    Returns:
    
    a String object.
  - getDescription
```
public String getDescription()
```
    Getter for the field description.
    
    Returns:
    
    a String object.
  - getLogMessage
```
public String getLogMessage()
```
    Getter for the field logMessage.
    
    Returns:
    
    a String object.
  - getLogGroup
```
public String getLogGroup()
```
    Getter for the field logGroup.
    
    Returns:
    
    a String object.
  - getOperatorInstruction
```
public String getOperatorInstruction()
```
    Getter for the field operatorInstruction.
    
    Returns:
    
    a String object.
  - getAutoAction
```
public String getAutoAction()
```
    Getter for the field autoAction.
    
    Returns:
    
    a String object.
  - getOperatorAction
```
public String getOperatorAction()
```
    Getter for the field operatorAction.
    
    Returns:
    
    a String object.
  - getOperatorActionMenuText
```
public String getOperatorActionMenuText()
```
    Getter for the field operatorActionMenuText.
    
    Returns:
    
    a String object.
  - getNotification
```
public String getNotification()
```
    Getter for the field notification.
    
    Returns:
    
    a String object.
  - getTroubleTicket
```
public String getTroubleTicket()
```
    Getter for the field troubleTicket.
    
    Returns:
    
    a String object.
  - getTroubleTicketState
```
public Integer getTroubleTicketState()
```
    Getter for the field troubleTicketState.
    
    Returns:
    
    a Integer object.
  - getForward
```
public String getForward()
```
    Getter for the field forward.
    
    Returns:
    
    a String object.
  - getMouseOverText
```
public String getMouseOverText()
```
    Getter for the field mouseOverText.
    
    Returns:
    
    a String object.
  - getAcknowledgeUser
```
public String getAcknowledgeUser()
```
    Getter for the field acknowledgeUser.
    
    Returns:
    
    a String object.
  - getAcknowledgeTime
```
public Date getAcknowledgeTime()
```
    Getter for the field acknowledgeTime.
    
    Returns:
    
    a Date object.
  - isAcknowledged
```
public boolean isAcknowledged()
```
    isAcknowledged
    
    Returns:
    
    a boolean.
  - getAlarmId
```
public Integer getAlarmId()
```
    Getter for the field alarmId.
    
    Returns:
    
    a Integer object.
  - getEventDisplay
```
public Boolean getEventDisplay()
```
    Getter for the field eventDisplay.
    
    Returns:
    
    a Boolean object.
  - getSystemId
```
public String getSystemId()
```
  - getLocation
```
public String getLocation()
```
  - getNodeLocation
```
public String getNodeLocation()
```

Class Event

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

uei

snmp

time

host

snmphost

dpName

parms

nodeID

serviceID

serviceName

ipAddr

createTime

description

logMessage

logGroup

severity

operatorInstruction

autoAction

operatorAction

operatorActionMenuText

notification

troubleTicket

troubleTicketState

forward

mouseOverText

acknowledgeUser

acknowledgeTime

nodeLabel

alarmId

eventDisplay

systemId

location

nodeLocation

Constructor Detail

Event

Event

Event

Event

Event

Method Detail

getId

getUei

getTime

getDpName

getCreateTime

getSeverity

getSnmp

getHost

getSnmpHost

getParms

getNodeId

getNodeLabel

getServiceId

getServiceName

getIpAddress

getDescription

getLogMessage

getLogGroup

getOperatorInstruction

getAutoAction

getOperatorAction

getOperatorActionMenuText

getNotification

getTroubleTicket

getTroubleTicketState

getForward

getMouseOverText

getAcknowledgeUser

getAcknowledgeTime

isAcknowledged

getAlarmId

getEventDisplay

getSystemId