Class OnmsAlarm
- java.lang.Object
-
- org.opennms.netmgt.model.OnmsAlarm
-
- All Implemented Interfaces:
Serializable,Acknowledgeable
@Entity public class OnmsAlarm extends Object implements Acknowledgeable, Serializable
OnmsAlarm class.
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static StringARCHIVEDstatic intPROBLEM_TYPEConstantPROBLEM_TYPE=1static intPROBLEM_WITHOUT_RESOLUTION_TYPEConstantPROBLEM_WITHOUT_RESOLUTION_TYPE=3static intRESOLUTION_TYPEConstantRESOLUTION_TYPE=2
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidacknowledge(String user)acknowledgevoidaddRelatedAlarm(OnmsAlarm alarm)voidarchive()This marks an alarm as archived and prevents it from being used again in during reduction.voidclear(String ackUser)clearvoidescalate(String ackUser)escalateOptional<OnmsEventParameter>findEventParameter(String name)IntegergetAckId()getAckIdDategetAckTime()getAckTimeStringgetAckUser()getAckUserIntegergetAffectedNodeCount()DategetAlarmAckTime()getAlarmAckTimeStringgetAlarmAckUser()getAlarmAckUserIntegergetAlarmType()getAlarmTypeStringgetApplicationDN()getApplicationDNSet<AlarmAssociation>getAssociatedAlarms()StringgetClearKey()getClearKeyIntegergetCounter()getCounterStringgetDescription()getDescriptionMap<String,String>getDetails()getDetailsOnmsMonitoringSystemgetDistPoller()getDistPollerStringgetEventParameter(String name)List<OnmsEventParameter>getEventParameters()DategetFirstAutomationTime()getFirstAutomationTimeDategetFirstEventTime()getFirstEventTimeIntegergetId()getIdIntegergetIfIndex()getIfIndexInetAddressgetIpAddr()getIpAddrDategetLastAutomationTime()getLastAutomationTimeOnmsEventgetLastEvent()getLastEventDategetLastEventTime()getLastEventTimeDategetLastUpdateTime()StringgetLogMsg()getLogMsgStringgetManagedObjectInstance()getManagedObjectInstanceStringgetManagedObjectType()getManagedObjectTypeStringgetMouseOverText()getMouseOverTextOnmsNodegetNode()getNodeIntegergetNodeId()StringgetNodeLabel()StringgetOperInstruct()getOperInstructStringgetOssPrimaryKey()getOssPrimaryKeyStringgetQosAlarmState()getQosAlarmStateStringgetReductionKey()getReductionKeyOnmsReductionKeyMemogetReductionKeyMemo()Set<Integer>getRelatedAlarmIds()Set<OnmsAlarm>getRelatedAlarms()getRelatedAlarmsSet<Integer>getRelatedSituationIds()Set<OnmsAlarm>getRelatedSituations()OnmsServiceTypegetServiceType()getServiceTypeOnmsSeveritygetSeverity()getSeverityIntegergetSeverityId()getSeverityIdStringgetSeverityLabel()getSeverityLabelOnmsMemogetStickyMemo()DategetSuppressedTime()getSuppressedTimeDategetSuppressedUntil()getSuppressedUntilStringgetSuppressedUser()getSuppressedUserStringgetTTicketId()getTTicketIdTroubleTicketStategetTTicketState()getTTicketStateAckTypegetType()getTypeStringgetUei()getUeiStringgetX733AlarmType()getX733AlarmTypeintgetX733ProbableCause()getX733ProbableCausebooleanisAcknowledged()booleanisArchived()booleanisPartOfSituation()booleanisSituation()voidremoveRelatedAlarm(OnmsAlarm alarm)voidremoveRelatedAlarmWithId(Integer relatedAlarmId)voidsetAlarmAckTime(Date alarmacktime)setAlarmAckTimevoidsetAlarmAckUser(String alarmackuser)setAlarmAckUservoidsetAlarmType(Integer alarmtype)setAlarmTypevoidsetApplicationDN(String applicationDN)setApplicationDNvoidsetAssociatedAlarms(Set<AlarmAssociation> alarms)voidsetClearKey(String clearKey)setClearKeyvoidsetCounter(Integer counter)setCountervoidsetDescription(String description)setDescriptionvoidsetDetails(Map<String,String> alarmDetails)setDetailsvoidsetDistPoller(OnmsMonitoringSystem distPoller)setDistPollervoidsetFirstAutomationTime(Date firstAutomationTime)setFirstAutomationTimevoidsetFirstEventTime(Date firsteventtime)setFirstEventTimevoidsetId(Integer alarmid)setIdvoidsetIfIndex(Integer ifIndex)setIfIndexvoidsetIpAddr(InetAddress ipaddr)setIpAddrvoidsetLastAutomationTime(Date lastAutomationTime)setLastAutomationTimevoidsetLastEvent(OnmsEvent event)setLastEventvoidsetLastEventTime(Date lastEventTime)setLastEventTimevoidsetLogMsg(String logmsg)setLogMsgvoidsetManagedObjectInstance(String managedObjectInstance)setManagedObjectInstancevoidsetManagedObjectType(String managedObjectType)setManagedObjectTypevoidsetMouseOverText(String mouseovertext)setMouseOverTextvoidsetNode(OnmsNode node)setNodevoidsetOperInstruct(String operinstruct)setOperInstructvoidsetOssPrimaryKey(String key)setOssPrimaryKeyvoidsetPartOfSituation(boolean partOfSituation)voidsetQosAlarmState(String alarmState)setQosAlarmStatevoidsetReductionKey(String reductionkey)setReductionKeyvoidsetReductionKeyMemo(OnmsReductionKeyMemo reductionKeyMemo)voidsetRelatedAlarms(Set<OnmsAlarm> alarms)voidsetRelatedAlarms(Set<OnmsAlarm> alarms, Date associationEventTime)voidsetRelatedSituations(Set<OnmsAlarm> alarms)voidsetServiceType(OnmsServiceType service)setServiceTypevoidsetSeverity(OnmsSeverity severity)setSeverityvoidsetSeverityId(Integer severity)setSeverityIdvoidsetSeverityLabel(String label)setSeverityLabelvoidsetSituation(boolean situation)voidsetStickyMemo(OnmsMemo stickyMemo)voidsetSuppressedTime(Date suppressedtime)setSuppressedTimevoidsetSuppressedUntil(Date suppresseduntil)setSuppressedUntilvoidsetSuppressedUser(String suppresseduser)setSuppressedUservoidsetTTicketId(String tticketid)setTTicketIdvoidsetTTicketState(TroubleTicketState tticketstate)setTTicketStatevoidsetUei(String eventuei)setUeivoidsetX733AlarmType(String alarmType)setX733AlarmTypevoidsetX733ProbableCause(int cause)setX733ProbableCauseStringtoString()toStringvoidunacknowledge(String ackUser)unacknowledge
-
-
-
Field Detail
-
PROBLEM_TYPE
public static final int PROBLEM_TYPE
ConstantPROBLEM_TYPE=1- See Also:
- Constant Field Values
-
RESOLUTION_TYPE
public static final int RESOLUTION_TYPE
ConstantRESOLUTION_TYPE=2- See Also:
- Constant Field Values
-
PROBLEM_WITHOUT_RESOLUTION_TYPE
public static final int PROBLEM_WITHOUT_RESOLUTION_TYPE
ConstantPROBLEM_WITHOUT_RESOLUTION_TYPE=3- See Also:
- Constant Field Values
-
ARCHIVED
public static final String ARCHIVED
- See Also:
- Constant Field Values
-
-
Method Detail
-
getDistPoller
public OnmsMonitoringSystem getDistPoller()
getDistPoller
- Returns:
- a
OnmsDistPollerobject.
-
setDistPoller
public void setDistPoller(OnmsMonitoringSystem distPoller)
setDistPoller
- Parameters:
distPoller- aOnmsDistPollerobject.
-
getNode
public OnmsNode getNode()
getNode
- Specified by:
getNodein interfaceAcknowledgeable- Returns:
- a
OnmsNodeobject.
-
getNodeId
public Integer getNodeId()
-
getNodeLabel
public String getNodeLabel()
-
getIpAddr
public InetAddress getIpAddr()
getIpAddr
- Returns:
- a
Stringobject.
-
setIpAddr
public void setIpAddr(InetAddress ipaddr)
setIpAddr
- Parameters:
ipaddr- aStringobject.
-
getServiceType
public OnmsServiceType getServiceType()
getServiceType
- Returns:
- a
OnmsServiceTypeobject.
-
setServiceType
public void setServiceType(OnmsServiceType service)
setServiceType
- Parameters:
service- aOnmsServiceTypeobject.
-
setReductionKey
public void setReductionKey(String reductionkey)
setReductionKey
- Parameters:
reductionkey- aStringobject.
-
setAlarmType
public void setAlarmType(Integer alarmtype)
setAlarmType
- Parameters:
alarmtype- aIntegerobject.
-
setCounter
public void setCounter(Integer counter)
setCounter
- Parameters:
counter- aIntegerobject.
-
setSeverityLabel
public void setSeverityLabel(String label)
setSeverityLabel
- Parameters:
label- aStringobject.
-
getSeverity
public OnmsSeverity getSeverity()
getSeverity
- Specified by:
getSeverityin interfaceAcknowledgeable- Returns:
- a
OnmsSeverityobject.
-
setSeverity
public void setSeverity(OnmsSeverity severity)
setSeverity
- Parameters:
severity- aOnmsSeverityobject.
-
setSeverityId
public void setSeverityId(Integer severity)
setSeverityId
- Parameters:
severity- aIntegerobject.
-
setFirstEventTime
public void setFirstEventTime(Date firsteventtime)
setFirstEventTime
- Parameters:
firsteventtime- aDateobject.
-
setDescription
public void setDescription(String description)
setDescription
- Parameters:
description- aStringobject.
-
setOperInstruct
public void setOperInstruct(String operinstruct)
setOperInstruct
- Parameters:
operinstruct- aStringobject.
-
setTTicketId
public void setTTicketId(String tticketid)
setTTicketId
- Parameters:
tticketid- aStringobject.
-
getTTicketState
public TroubleTicketState getTTicketState()
getTTicketState
- Returns:
- a
TroubleTicketStateobject.
-
setTTicketState
public void setTTicketState(TroubleTicketState tticketstate)
setTTicketState
- Parameters:
tticketstate- aTroubleTicketStateobject.
-
setMouseOverText
public void setMouseOverText(String mouseovertext)
setMouseOverText
- Parameters:
mouseovertext- aStringobject.
-
setSuppressedUntil
public void setSuppressedUntil(Date suppresseduntil)
setSuppressedUntil
- Parameters:
suppresseduntil- aDateobject.
-
setSuppressedUser
public void setSuppressedUser(String suppresseduser)
setSuppressedUser
- Parameters:
suppresseduser- aStringobject.
-
setSuppressedTime
public void setSuppressedTime(Date suppressedtime)
setSuppressedTime
- Parameters:
suppressedtime- aDateobject.
-
setAlarmAckUser
public void setAlarmAckUser(String alarmackuser)
setAlarmAckUser
- Parameters:
alarmackuser- aStringobject.
-
isAcknowledged
public boolean isAcknowledged()
-
setAlarmAckTime
public void setAlarmAckTime(Date alarmacktime)
setAlarmAckTime
- Parameters:
alarmacktime- aDateobject.
-
setClearKey
public void setClearKey(String clearKey)
setClearKey
- Parameters:
clearKey- aStringobject.
-
setLastEvent
public void setLastEvent(OnmsEvent event)
setLastEvent
- Parameters:
event- aOnmsEventobject.
-
getEventParameters
public List<OnmsEventParameter> getEventParameters()
-
findEventParameter
public Optional<OnmsEventParameter> findEventParameter(String name)
-
toString
public String toString()
toString
-
setLastEventTime
public void setLastEventTime(Date lastEventTime)
setLastEventTime
- Parameters:
lastEventTime- aDateobject.
-
setApplicationDN
public void setApplicationDN(String applicationDN)
setApplicationDN
- Parameters:
applicationDN- aStringobject.
-
getManagedObjectInstance
public String getManagedObjectInstance()
getManagedObjectInstance
- Returns:
- a
Stringobject.
-
setManagedObjectInstance
public void setManagedObjectInstance(String managedObjectInstance)
setManagedObjectInstance
- Parameters:
managedObjectInstance- aStringobject.
-
getManagedObjectType
public String getManagedObjectType()
getManagedObjectType
- Returns:
- a
Stringobject.
-
setManagedObjectType
public void setManagedObjectType(String managedObjectType)
setManagedObjectType
- Parameters:
managedObjectType- aStringobject.
-
setOssPrimaryKey
public void setOssPrimaryKey(String key)
setOssPrimaryKey
- Parameters:
key- aStringobject.
-
setX733AlarmType
public void setX733AlarmType(String alarmType)
setX733AlarmType
- Parameters:
alarmType- aStringobject.
-
getX733ProbableCause
public int getX733ProbableCause()
getX733ProbableCause
- Returns:
- a int.
-
setX733ProbableCause
public void setX733ProbableCause(int cause)
setX733ProbableCause
- Parameters:
cause- a int.
-
setQosAlarmState
public void setQosAlarmState(String alarmState)
setQosAlarmState
- Parameters:
alarmState- aStringobject.
-
getFirstAutomationTime
public Date getFirstAutomationTime()
getFirstAutomationTime
- Returns:
- a
Dateobject.
-
setFirstAutomationTime
public void setFirstAutomationTime(Date firstAutomationTime)
setFirstAutomationTime
- Parameters:
firstAutomationTime- aDateobject.
-
getLastAutomationTime
public Date getLastAutomationTime()
getLastAutomationTime
- Returns:
- a
Dateobject.
-
setLastAutomationTime
public void setLastAutomationTime(Date lastAutomationTime)
setLastAutomationTime
- Parameters:
lastAutomationTime- aDateobject.
-
setDetails
public void setDetails(Map<String,String> alarmDetails)
setDetails
- Parameters:
alarmDetails- aMapobject.
-
setIfIndex
public void setIfIndex(Integer ifIndex)
setIfIndex
- Parameters:
ifIndex- aIntegerobject.
-
getReductionKeyMemo
public OnmsReductionKeyMemo getReductionKeyMemo()
-
setReductionKeyMemo
public void setReductionKeyMemo(OnmsReductionKeyMemo reductionKeyMemo)
-
getStickyMemo
public OnmsMemo getStickyMemo()
-
setStickyMemo
public void setStickyMemo(OnmsMemo stickyMemo)
-
acknowledge
public void acknowledge(String user)
acknowledge
- Specified by:
acknowledgein interfaceAcknowledgeable- Parameters:
user- aStringobject.
-
unacknowledge
public void unacknowledge(String ackUser)
unacknowledge
- Specified by:
unacknowledgein interfaceAcknowledgeable- Parameters:
ackUser- aStringobject.
-
clear
public void clear(String ackUser)
clear
- Specified by:
clearin interfaceAcknowledgeable- Parameters:
ackUser- aStringobject.
-
escalate
public void escalate(String ackUser)
escalate
- Specified by:
escalatein interfaceAcknowledgeable- Parameters:
ackUser- aStringobject.
-
archive
public void archive()
This marks an alarm as archived and prevents it from being used again in during reduction.
-
isArchived
public boolean isArchived()
-
getType
public AckType getType()
getType
- Specified by:
getTypein interfaceAcknowledgeable- Returns:
- a
AckTypeobject.
-
getAckId
public Integer getAckId()
getAckId
- Specified by:
getAckIdin interfaceAcknowledgeable- Returns:
- a
Integerobject.
-
getAckUser
public String getAckUser()
getAckUser
- Specified by:
getAckUserin interfaceAcknowledgeable- Returns:
- a
Stringobject.
-
getAckTime
public Date getAckTime()
getAckTime
- Specified by:
getAckTimein interfaceAcknowledgeable- Returns:
- a
Dateobject.
-
getAssociatedAlarms
public Set<AlarmAssociation> getAssociatedAlarms()
-
setAssociatedAlarms
public void setAssociatedAlarms(Set<AlarmAssociation> alarms)
-
addRelatedAlarm
public void addRelatedAlarm(OnmsAlarm alarm)
-
removeRelatedAlarm
public void removeRelatedAlarm(OnmsAlarm alarm)
-
removeRelatedAlarmWithId
public void removeRelatedAlarmWithId(Integer relatedAlarmId)
-
isSituation
public boolean isSituation()
-
setSituation
public void setSituation(boolean situation)
-
isPartOfSituation
public boolean isPartOfSituation()
-
setPartOfSituation
public void setPartOfSituation(boolean partOfSituation)
-
getAffectedNodeCount
public Integer getAffectedNodeCount()
-
getLastUpdateTime
public Date getLastUpdateTime()
-
-