NorthboundAlarm (OpenNMS 2021.1.1 API)

java.lang.Object
- org.opennms.netmgt.alarmd.api.NorthboundAlarm

All Implemented Interfaces:

Serializable, Preservable
```
public class NorthboundAlarm
extends Object
implements Preservable, Serializable
```
Wraps the OnmsAlarm into a more generic Alarm instance FIXME: Improve this alarm to support TIP and 3GPP collaboration. FIXME: Most of these fields are not implemented waiting on above fix to be completed.

Author:

David Hustace, Alejandro Galue

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`NorthboundAlarm.AlarmType` The Enumeration AlarmType.
`static class`	`NorthboundAlarm.x733AlarmType` The Enumeration x733AlarmType.
`static class`	`NorthboundAlarm.x733ProbableCause` The Enumeration x733ProbableCause.

Field Summary

Fields
Modifier and Type Field and Description

static NorthboundAlarm SYNC_LOST_ALARM
The Constant SYNC_LOST_ALARM.

Fields
Modifier and Type	Field and Description
`static NorthboundAlarm`	`SYNC_LOST_ALARM` The Constant SYNC_LOST_ALARM.

Constructor Summary

Constructors
Constructor and Description

NorthboundAlarm()
Instantiates a new northbound alarm.

NorthboundAlarm(OnmsAlarm alarm)
Instantiates a new northbound alarm.

Constructors
Constructor and Description
`NorthboundAlarm()` Instantiates a new northbound alarm.
`NorthboundAlarm(OnmsAlarm alarm)` Instantiates a new northbound alarm.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Date`	`getAckTime()` Gets the acknowledge time.
`String`	`getAckUser()` Gets the acknowledge user.
`String`	`getAlarmKey()` Gets the alarm key.
`NorthboundAlarm.AlarmType`	`getAlarmType()` Gets the alarm type.
`String`	`getAppDn()` Gets the App DN.
`String`	`getClearKey()` Gets the clear key.
`Integer`	`getCount()` Gets the count.
`String`	`getDesc()` Gets the description.
`List<OnmsEventParameter>`	`getEventParametersCollection()` Gets the event parameters collection.
`Date`	`getFirstOccurrence()` Gets the first occurrence.
`String`	`getForeignId()` Gets the node foreign id.
`String`	`getForeignSource()` Gets the node foreign source.
`Integer`	`getId()` Gets the ID.
`String`	`getIpAddr()` Gets the IP address.
`Date`	`getLastOccurrence()` Gets the last occurrence.
`String`	`getLogMsg()` Gets the log message.
`Integer`	`getNodeId()` Gets the node id.
`String`	`getNodeLabel()` Gets the node label.
`String`	`getNodeSysObjectId()` Gets the node system object id.
`String`	`getObjectInstance()` Gets the object instance.
`String`	`getObjectType()` Gets the object type.
`String`	`getOperInst()` Gets the operator instructions.
`String`	`getOssKey()` Gets the OSS key.
`String`	`getOssState()` Gets the OSS state.
`Map<String,String>`	`getParameters()` Gets the parameters.
`OnmsMonitoringSystem`	`getPoller()` Gets the poller.
`String`	`getService()` Gets the service.
`OnmsSeverity`	`getSeverity()` Gets the severity.
`Date`	`getSuppressed()` Gets the suppressed.
`String`	`getSuppressedBy()` Gets the suppressed by.
`Date`	`getSuppressedUntil()` Gets the suppressed until.
`String`	`getTicketId()` Gets the ticket id.
`TroubleTicketState`	`getTicketState()` Gets the ticket state.
`String`	`getUei()` Gets the UEI.
`int`	`getX733Cause()` Gets the x733 cause.
`String`	`getX733Type()` Gets the x733 type.
`int`	`hashCode()`
`boolean`	`isPreserved()` Checks if is preserved.
`void`	`setAckTime(Date ackTime)` Sets the acknowledge time.
`void`	`setAckUser(String ackUser)` Sets the acknowledge user.
`void`	`setAlarmKey(String alarmKey)` Sets the alarm key.
`void`	`setAlarmType(NorthboundAlarm.AlarmType alarmType)` Sets the alarm type.
`void`	`setAppDn(String appDn)` Sets the App DN.
`void`	`setClearKey(String clearKey)` Sets the clear key.
`void`	`setCount(Integer count)` Sets the count.
`void`	`setDesc(String desc)` Sets the description.
`void`	`setEventParametersCollection(List<OnmsEventParameter> eventParametersCollection)` Sets the event parameters collection.
`void`	`setEventParametersMap(Map<String,String> eventParametersMap)` Sets the event parameters map.
`void`	`setFirstOccurrence(Date firstOccurrence)` Sets the first occurrence.
`void`	`setForeignId(String foreignId)` Sets the foreign id.
`void`	`setForeignSource(String foreignSource)` Sets the foreign source.
`void`	`setId(Integer id)` Sets the id.
`void`	`setIpAddr(String ipAddr)` Sets the IP address.
`void`	`setLastOccurrence(Date lastOccurrence)` Sets the last occurrence.
`void`	`setLogMsg(String logMsg)` Sets the log message.
`void`	`setNodeId(Integer nodeId)` Sets the node id.
`void`	`setNodeLabel(String nodeLabel)` Sets the node label.
`void`	`setNodeSysObjectId(String nodeSysObjectId)` Sets the node sys object id.
`void`	`setObjectInstance(String objectInstance)` Sets the object instance.
`void`	`setObjectType(String objectType)` Sets the object type.
`void`	`setOperInst(String operInst)` Sets the operator instructions.
`void`	`setOssKey(String ossKey)` Sets the OSS key.
`void`	`setOssState(String ossState)` Sets the OSS state.
`void`	`setPoller(OnmsDistPoller poller)` Sets the poller.
`void`	`setPreserved(boolean preserved)` Sets the preserved.
`void`	`setService(String service)` Sets the service.
`void`	`setSeverity(OnmsSeverity severity)` Sets the severity.
`void`	`setSuppressed(Date suppressed)` Sets the suppressed.
`void`	`setSuppressedBy(String suppressedBy)` Sets the suppressed by.
`void`	`setSuppressedUntil(Date suppressedUntil)` Sets the suppressed until.
`void`	`setTicketId(String ticketId)` Sets the ticket id.
`void`	`setTicketState(TroubleTicketState ticketState)` Sets the ticket state.
`void`	`setUei(String uei)` Sets the UEI.
`void`	`setx733Cause(int x733Cause)` Sets the x733 cause.
`void`	`setx733Type(String x733Type)` Sets the x733 type.
`String`	`toString()`

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

- Field Detail
  - SYNC_LOST_ALARM
```
public static final NorthboundAlarm SYNC_LOST_ALARM
```
    The Constant SYNC_LOST_ALARM.
- Constructor Detail
  - NorthboundAlarm
```
public NorthboundAlarm()
```
    Instantiates a new northbound alarm.
  - NorthboundAlarm
```
public NorthboundAlarm(OnmsAlarm alarm)
```
    Instantiates a new northbound alarm.
    
    Parameters:
    
    alarm - the alarm
- Method Detail
  - getId
```
public Integer getId()
```
    Gets the ID.
    
    Returns:
    
    the ID
  - getUei
```
public String getUei()
```
    Gets the UEI.
    
    Returns:
    
    the UEI
  - getAckTime
```
public Date getAckTime()
```
    Gets the acknowledge time.
    
    Returns:
    
    the acknowledge time
  - getAckUser
```
public String getAckUser()
```
    Gets the acknowledge user.
    
    Returns:
    
    the acknowledge user
  - getAlarmType
```
public NorthboundAlarm.AlarmType getAlarmType()
```
    Gets the alarm type.
    
    Returns:
    
    the alarm type
  - getAppDn
```
public String getAppDn()
```
    Gets the App DN.
    
    Returns:
    
    the App DN
  - getClearKey
```
public String getClearKey()
```
    Gets the clear key.
    
    Returns:
    
    the clear key
  - getCount
```
public Integer getCount()
```
    Gets the count.
    
    Returns:
    
    the count
  - getDesc
```
public String getDesc()
```
    Gets the description.
    
    Returns:
    
    the description
  - getPoller
```
public OnmsMonitoringSystem getPoller()
```
    Gets the poller.
    
    Returns:
    
    the poller
  - getFirstOccurrence
```
public Date getFirstOccurrence()
```
    Gets the first occurrence.
    
    Returns:
    
    the first occurrence
  - getIpAddr
```
public String getIpAddr()
```
    Gets the IP address.
    
    Returns:
    
    the IP address
  - getLastOccurrence
```
public Date getLastOccurrence()
```
    Gets the last occurrence.
    
    Returns:
    
    the last occurrence
  - getLogMsg
```
public String getLogMsg()
```
    Gets the log message.
    
    Returns:
    
    the log message
  - getObjectInstance
```
public String getObjectInstance()
```
    Gets the object instance.
    
    Returns:
    
    the object instance
  - getObjectType
```
public String getObjectType()
```
    Gets the object type.
    
    Returns:
    
    the object type
  - getOperInst
```
public String getOperInst()
```
    Gets the operator instructions.
    
    Returns:
    
    the operator instructions
  - getOssKey
```
public String getOssKey()
```
    Gets the OSS key.
    
    Returns:
    
    the OSS key
  - getOssState
```
public String getOssState()
```
    Gets the OSS state.
    
    Returns:
    
    the OSS state
  - getAlarmKey
```
public String getAlarmKey()
```
    Gets the alarm key.
    
    Returns:
    
    the alarm key
  - getService
```
public String getService()
```
    Gets the service.
    
    Returns:
    
    the service
  - getSeverity
```
public OnmsSeverity getSeverity()
```
    Gets the severity.
    
    Returns:
    
    the severity
  - getSuppressed
```
public Date getSuppressed()
```
    Gets the suppressed.
    
    Returns:
    
    the suppressed
  - getSuppressedUntil
```
public Date getSuppressedUntil()
```
    Gets the suppressed until.
    
    Returns:
    
    the suppressed until
  - getSuppressedBy
```
public String getSuppressedBy()
```
    Gets the suppressed by.
    
    Returns:
    
    the suppressed by
  - getTicketId
```
public String getTicketId()
```
    Gets the ticket id.
    
    Returns:
    
    the ticket id
  - getTicketState
```
public TroubleTicketState getTicketState()
```
    Gets the ticket state.
    
    Returns:
    
    the ticket state
  - getX733Type
```
public String getX733Type()
```
    Gets the x733 type.
    
    Returns:
    
    the x733 type
  - getX733Cause
```
public int getX733Cause()
```
    Gets the x733 cause.
    
    Returns:
    
    the x733 cause
  - getParameters
```
public Map<String,String> getParameters()
```
    Gets the parameters.
    
    Returns:
    
    the parameters
  - getEventParametersCollection
```
public List<OnmsEventParameter> getEventParametersCollection()
```
    Gets the event parameters collection.
    
    Returns:
    
    the event parameters collection
  - isPreserved
```
public boolean isPreserved()
```
    Description copied from interface: Preservable
    
    Checks if is preserved.
    
    Specified by:
    
    isPreserved in interface Preservable
    
    Returns:
    
    true, if is preserved
  - setPreserved
```
public void setPreserved(boolean preserved)
```
    Description copied from interface: Preservable
    
    Sets the preserved.
    
    Specified by:
    
    setPreserved in interface Preservable
    
    Parameters:
    
    preserved - the new preserved
  - getNodeId
```
public Integer getNodeId()
```
    Gets the node id.
    
    Returns:
    
    the node id
  - getNodeLabel
```
public String getNodeLabel()
```
    Gets the node label.
    
    Returns:
    
    the node label
  - getNodeSysObjectId
```
public String getNodeSysObjectId()
```
    Gets the node system object id.
    
    Returns:
    
    the node system object id
  - getForeignSource
```
public String getForeignSource()
```
    Gets the node foreign source.
    
    Returns:
    
    the node foreign source
  - getForeignId
```
public String getForeignId()
```
    Gets the node foreign id.
    
    Returns:
    
    the node foreign id
  - setId
```
public void setId(Integer id)
```
    Sets the id.
    
    Parameters:
    
    id - the new id
  - setUei
```
public void setUei(String uei)
```
    Sets the UEI.
    
    Parameters:
    
    uei - the new UEI
  - setNodeId
```
public void setNodeId(Integer nodeId)
```
    Sets the node id.
    
    Parameters:
    
    nodeId - the new node id
  - setNodeLabel
```
public void setNodeLabel(String nodeLabel)
```
    Sets the node label.
    
    Parameters:
    
    nodeLabel - the new node label
  - setNodeSysObjectId
```
public void setNodeSysObjectId(String nodeSysObjectId)
```
    Sets the node sys object id.
    
    Parameters:
    
    nodeSysObjectId - the new node sys object id
  - setForeignSource
```
public void setForeignSource(String foreignSource)
```
    Sets the foreign source.
    
    Parameters:
    
    foreignSource - the new foreign source
  - setForeignId
```
public void setForeignId(String foreignId)
```
    Sets the foreign id.
    
    Parameters:
    
    foreignId - the new foreign id
  - setAckTime
```
public void setAckTime(Date ackTime)
```
    Sets the acknowledge time.
    
    Parameters:
    
    ackTime - the new acknowledge time
  - setAckUser
```
public void setAckUser(String ackUser)
```
    Sets the acknowledge user.
    
    Parameters:
    
    ackUser - the new acknowledge user
  - setAlarmType
```
public void setAlarmType(NorthboundAlarm.AlarmType alarmType)
```
    Sets the alarm type.
    
    Parameters:
    
    alarmType - the new alarm type
  - setAppDn
```
public void setAppDn(String appDn)
```
    Sets the App DN.
    
    Parameters:
    
    appDn - the new App DN
  - setClearKey
```
public void setClearKey(String clearKey)
```
    Sets the clear key.
    
    Parameters:
    
    clearKey - the new clear key
  - setCount
```
public void setCount(Integer count)
```
    Sets the count.
    
    Parameters:
    
    count - the new count
  - setDesc
```
public void setDesc(String desc)
```
    Sets the description.
    
    Parameters:
    
    desc - the new description
  - setPoller
```
public void setPoller(OnmsDistPoller poller)
```
    Sets the poller.
    
    Parameters:
    
    poller - the new poller
  - setFirstOccurrence
```
public void setFirstOccurrence(Date firstOccurrence)
```
    Sets the first occurrence.
    
    Parameters:
    
    firstOccurrence - the new first occurrence
  - setIpAddr
```
public void setIpAddr(String ipAddr)
```
    Sets the IP address.
    
    Parameters:
    
    ipAddr - the new IP address
  - setLastOccurrence
```
public void setLastOccurrence(Date lastOccurrence)
```
    Sets the last occurrence.
    
    Parameters:
    
    lastOccurrence - the new last occurrence
  - setLogMsg
```
public void setLogMsg(String logMsg)
```
    Sets the log message.
    
    Parameters:
    
    logMsg - the new log message
  - setObjectInstance
```
public void setObjectInstance(String objectInstance)
```
    Sets the object instance.
    
    Parameters:
    
    objectInstance - the new object instance
  - setObjectType
```
public void setObjectType(String objectType)
```
    Sets the object type.
    
    Parameters:
    
    objectType - the new object type
  - setOperInst
```
public void setOperInst(String operInst)
```
    Sets the operator instructions.
    
    Parameters:
    
    operInst - the new operator instructions
  - setOssKey
```
public void setOssKey(String ossKey)
```
    Sets the OSS key.
    
    Parameters:
    
    ossKey - the new OSS key
  - setOssState
```
public void setOssState(String ossState)
```
    Sets the OSS state.
    
    Parameters:
    
    ossState - the new OSS state
  - setAlarmKey
```
public void setAlarmKey(String alarmKey)
```
    Sets the alarm key.
    
    Parameters:
    
    alarmKey - the new alarm key
  - setService
```
public void setService(String service)
```
    Sets the service.
    
    Parameters:
    
    service - the new service
  - setSeverity
```
public void setSeverity(OnmsSeverity severity)
```
    Sets the severity.
    
    Parameters:
    
    severity - the new severity
  - setSuppressed
```
public void setSuppressed(Date suppressed)
```
    Sets the suppressed.
    
    Parameters:
    
    suppressed - the new suppressed
  - setSuppressedUntil
```
public void setSuppressedUntil(Date suppressedUntil)
```
    Sets the suppressed until.
    
    Parameters:
    
    suppressedUntil - the new suppressed until
  - setSuppressedBy
```
public void setSuppressedBy(String suppressedBy)
```
    Sets the suppressed by.
    
    Parameters:
    
    suppressedBy - the new suppressed by
  - setTicketId
```
public void setTicketId(String ticketId)
```
    Sets the ticket id.
    
    Parameters:
    
    ticketId - the new ticket id
  - setTicketState
```
public void setTicketState(TroubleTicketState ticketState)
```
    Sets the ticket state.
    
    Parameters:
    
    ticketState - the new ticket state
  - setx733Type
```
public void setx733Type(String x733Type)
```
    Sets the x733 type.
    
    Parameters:
    
    x733Type - the new x733 type
  - setx733Cause
```
public void setx733Cause(int x733Cause)
```
    Sets the x733 cause.
    
    Parameters:
    
    x733Cause - the new x733 cause
  - setEventParametersMap
```
public void setEventParametersMap(Map<String,String> eventParametersMap)
```
    Sets the event parameters map.
    
    Parameters:
    
    eventParametersMap - the event parameters map
  - setEventParametersCollection
```
public void setEventParametersCollection(List<OnmsEventParameter> eventParametersCollection)
```
    Sets the event parameters collection.
    
    Parameters:
    
    eventParametersCollection - the new event parameters collection
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class NorthboundAlarm

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SYNC_LOST_ALARM

Constructor Detail

NorthboundAlarm

NorthboundAlarm

Method Detail

getId

getUei

getAckTime

getAckUser

getAlarmType

getAppDn

getClearKey

getCount

getDesc

getPoller

getFirstOccurrence

getIpAddr

getLastOccurrence

getLogMsg

getObjectInstance

getObjectType

getOperInst

getOssKey

getOssState

getAlarmKey

getService

getSeverity

getSuppressed

getSuppressedUntil

getSuppressedBy

getTicketId

getTicketState

getX733Type

getX733Cause

getParameters

getEventParametersCollection

isPreserved

setPreserved

getNodeId

getNodeLabel

getNodeSysObjectId

getForeignSource

getForeignId

setId

setUei

setNodeId

setNodeLabel

setNodeSysObjectId

setForeignSource

setForeignId

setAckTime

setAckUser

setAlarmType

setAppDn

setClearKey

setCount

setDesc

setPoller

setFirstOccurrence

setIpAddr

setLastOccurrence

setLogMsg

setObjectInstance

setObjectType

setOperInst

setOssKey

setOssState

setAlarmKey

setService

setSeverity

setSuppressed

setSuppressedUntil

setSuppressedBy