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 String
ARCHIVED
static int
PROBLEM_TYPE
ConstantPROBLEM_TYPE=1
static int
PROBLEM_WITHOUT_RESOLUTION_TYPE
ConstantPROBLEM_WITHOUT_RESOLUTION_TYPE=3
static int
RESOLUTION_TYPE
ConstantRESOLUTION_TYPE=2
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
acknowledge(String user)
acknowledgevoid
addRelatedAlarm(OnmsAlarm alarm)
void
archive()
This marks an alarm as archived and prevents it from being used again in during reduction.void
clear(String ackUser)
clearvoid
escalate(String ackUser)
escalateOptional<OnmsEventParameter>
findEventParameter(String name)
Integer
getAckId()
getAckIdDate
getAckTime()
getAckTimeString
getAckUser()
getAckUserInteger
getAffectedNodeCount()
Date
getAlarmAckTime()
getAlarmAckTimeString
getAlarmAckUser()
getAlarmAckUserInteger
getAlarmType()
getAlarmTypeString
getApplicationDN()
getApplicationDNSet<AlarmAssociation>
getAssociatedAlarms()
String
getClearKey()
getClearKeyInteger
getCounter()
getCounterString
getDescription()
getDescriptionMap<String,String>
getDetails()
getDetailsOnmsMonitoringSystem
getDistPoller()
getDistPollerString
getEventParameter(String name)
List<OnmsEventParameter>
getEventParameters()
Date
getFirstAutomationTime()
getFirstAutomationTimeDate
getFirstEventTime()
getFirstEventTimeInteger
getId()
getIdInteger
getIfIndex()
getIfIndexInetAddress
getIpAddr()
getIpAddrDate
getLastAutomationTime()
getLastAutomationTimeOnmsEvent
getLastEvent()
getLastEventDate
getLastEventTime()
getLastEventTimeDate
getLastUpdateTime()
String
getLogMsg()
getLogMsgString
getManagedObjectInstance()
getManagedObjectInstanceString
getManagedObjectType()
getManagedObjectTypeString
getMouseOverText()
getMouseOverTextOnmsNode
getNode()
getNodeInteger
getNodeId()
String
getNodeLabel()
String
getOperInstruct()
getOperInstructString
getOssPrimaryKey()
getOssPrimaryKeyString
getQosAlarmState()
getQosAlarmStateString
getReductionKey()
getReductionKeyOnmsReductionKeyMemo
getReductionKeyMemo()
Set<Integer>
getRelatedAlarmIds()
Set<OnmsAlarm>
getRelatedAlarms()
getRelatedAlarmsSet<Integer>
getRelatedSituationIds()
Set<OnmsAlarm>
getRelatedSituations()
OnmsServiceType
getServiceType()
getServiceTypeOnmsSeverity
getSeverity()
getSeverityInteger
getSeverityId()
getSeverityIdString
getSeverityLabel()
getSeverityLabelOnmsMemo
getStickyMemo()
Date
getSuppressedTime()
getSuppressedTimeDate
getSuppressedUntil()
getSuppressedUntilString
getSuppressedUser()
getSuppressedUserString
getTTicketId()
getTTicketIdTroubleTicketState
getTTicketState()
getTTicketStateAckType
getType()
getTypeString
getUei()
getUeiString
getX733AlarmType()
getX733AlarmTypeint
getX733ProbableCause()
getX733ProbableCauseboolean
isAcknowledged()
boolean
isArchived()
boolean
isPartOfSituation()
boolean
isSituation()
void
removeRelatedAlarm(OnmsAlarm alarm)
void
removeRelatedAlarmWithId(Integer relatedAlarmId)
void
setAlarmAckTime(Date alarmacktime)
setAlarmAckTimevoid
setAlarmAckUser(String alarmackuser)
setAlarmAckUservoid
setAlarmType(Integer alarmtype)
setAlarmTypevoid
setApplicationDN(String applicationDN)
setApplicationDNvoid
setAssociatedAlarms(Set<AlarmAssociation> alarms)
void
setClearKey(String clearKey)
setClearKeyvoid
setCounter(Integer counter)
setCountervoid
setDescription(String description)
setDescriptionvoid
setDetails(Map<String,String> alarmDetails)
setDetailsvoid
setDistPoller(OnmsMonitoringSystem distPoller)
setDistPollervoid
setFirstAutomationTime(Date firstAutomationTime)
setFirstAutomationTimevoid
setFirstEventTime(Date firsteventtime)
setFirstEventTimevoid
setId(Integer alarmid)
setIdvoid
setIfIndex(Integer ifIndex)
setIfIndexvoid
setIpAddr(InetAddress ipaddr)
setIpAddrvoid
setLastAutomationTime(Date lastAutomationTime)
setLastAutomationTimevoid
setLastEvent(OnmsEvent event)
setLastEventvoid
setLastEventTime(Date lastEventTime)
setLastEventTimevoid
setLogMsg(String logmsg)
setLogMsgvoid
setManagedObjectInstance(String managedObjectInstance)
setManagedObjectInstancevoid
setManagedObjectType(String managedObjectType)
setManagedObjectTypevoid
setMouseOverText(String mouseovertext)
setMouseOverTextvoid
setNode(OnmsNode node)
setNodevoid
setOperInstruct(String operinstruct)
setOperInstructvoid
setOssPrimaryKey(String key)
setOssPrimaryKeyvoid
setPartOfSituation(boolean partOfSituation)
void
setQosAlarmState(String alarmState)
setQosAlarmStatevoid
setReductionKey(String reductionkey)
setReductionKeyvoid
setReductionKeyMemo(OnmsReductionKeyMemo reductionKeyMemo)
void
setRelatedAlarms(Set<OnmsAlarm> alarms)
void
setRelatedAlarms(Set<OnmsAlarm> alarms, Date associationEventTime)
void
setRelatedSituations(Set<OnmsAlarm> alarms)
void
setServiceType(OnmsServiceType service)
setServiceTypevoid
setSeverity(OnmsSeverity severity)
setSeverityvoid
setSeverityId(Integer severity)
setSeverityIdvoid
setSeverityLabel(String label)
setSeverityLabelvoid
setSituation(boolean situation)
void
setStickyMemo(OnmsMemo stickyMemo)
void
setSuppressedTime(Date suppressedtime)
setSuppressedTimevoid
setSuppressedUntil(Date suppresseduntil)
setSuppressedUntilvoid
setSuppressedUser(String suppresseduser)
setSuppressedUservoid
setTTicketId(String tticketid)
setTTicketIdvoid
setTTicketState(TroubleTicketState tticketstate)
setTTicketStatevoid
setUei(String eventuei)
setUeivoid
setX733AlarmType(String alarmType)
setX733AlarmTypevoid
setX733ProbableCause(int cause)
setX733ProbableCauseString
toString()
toStringvoid
unacknowledge(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
OnmsDistPoller
object.
-
setDistPoller
public void setDistPoller(OnmsMonitoringSystem distPoller)
setDistPoller
- Parameters:
distPoller
- aOnmsDistPoller
object.
-
getNode
public OnmsNode getNode()
getNode
- Specified by:
getNode
in interfaceAcknowledgeable
- Returns:
- a
OnmsNode
object.
-
getNodeId
public Integer getNodeId()
-
getNodeLabel
public String getNodeLabel()
-
getIpAddr
public InetAddress getIpAddr()
getIpAddr
- Returns:
- a
String
object.
-
setIpAddr
public void setIpAddr(InetAddress ipaddr)
setIpAddr
- Parameters:
ipaddr
- aString
object.
-
getServiceType
public OnmsServiceType getServiceType()
getServiceType
- Returns:
- a
OnmsServiceType
object.
-
setServiceType
public void setServiceType(OnmsServiceType service)
setServiceType
- Parameters:
service
- aOnmsServiceType
object.
-
setReductionKey
public void setReductionKey(String reductionkey)
setReductionKey
- Parameters:
reductionkey
- aString
object.
-
setAlarmType
public void setAlarmType(Integer alarmtype)
setAlarmType
- Parameters:
alarmtype
- aInteger
object.
-
setCounter
public void setCounter(Integer counter)
setCounter
- Parameters:
counter
- aInteger
object.
-
setSeverityLabel
public void setSeverityLabel(String label)
setSeverityLabel
- Parameters:
label
- aString
object.
-
getSeverity
public OnmsSeverity getSeverity()
getSeverity
- Specified by:
getSeverity
in interfaceAcknowledgeable
- Returns:
- a
OnmsSeverity
object.
-
setSeverity
public void setSeverity(OnmsSeverity severity)
setSeverity
- Parameters:
severity
- aOnmsSeverity
object.
-
setSeverityId
public void setSeverityId(Integer severity)
setSeverityId
- Parameters:
severity
- aInteger
object.
-
setFirstEventTime
public void setFirstEventTime(Date firsteventtime)
setFirstEventTime
- Parameters:
firsteventtime
- aDate
object.
-
setDescription
public void setDescription(String description)
setDescription
- Parameters:
description
- aString
object.
-
setOperInstruct
public void setOperInstruct(String operinstruct)
setOperInstruct
- Parameters:
operinstruct
- aString
object.
-
setTTicketId
public void setTTicketId(String tticketid)
setTTicketId
- Parameters:
tticketid
- aString
object.
-
getTTicketState
public TroubleTicketState getTTicketState()
getTTicketState
- Returns:
- a
TroubleTicketState
object.
-
setTTicketState
public void setTTicketState(TroubleTicketState tticketstate)
setTTicketState
- Parameters:
tticketstate
- aTroubleTicketState
object.
-
setMouseOverText
public void setMouseOverText(String mouseovertext)
setMouseOverText
- Parameters:
mouseovertext
- aString
object.
-
setSuppressedUntil
public void setSuppressedUntil(Date suppresseduntil)
setSuppressedUntil
- Parameters:
suppresseduntil
- aDate
object.
-
setSuppressedUser
public void setSuppressedUser(String suppresseduser)
setSuppressedUser
- Parameters:
suppresseduser
- aString
object.
-
setSuppressedTime
public void setSuppressedTime(Date suppressedtime)
setSuppressedTime
- Parameters:
suppressedtime
- aDate
object.
-
setAlarmAckUser
public void setAlarmAckUser(String alarmackuser)
setAlarmAckUser
- Parameters:
alarmackuser
- aString
object.
-
isAcknowledged
public boolean isAcknowledged()
-
setAlarmAckTime
public void setAlarmAckTime(Date alarmacktime)
setAlarmAckTime
- Parameters:
alarmacktime
- aDate
object.
-
setClearKey
public void setClearKey(String clearKey)
setClearKey
- Parameters:
clearKey
- aString
object.
-
setLastEvent
public void setLastEvent(OnmsEvent event)
setLastEvent
- Parameters:
event
- aOnmsEvent
object.
-
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
- aDate
object.
-
setApplicationDN
public void setApplicationDN(String applicationDN)
setApplicationDN
- Parameters:
applicationDN
- aString
object.
-
getManagedObjectInstance
public String getManagedObjectInstance()
getManagedObjectInstance
- Returns:
- a
String
object.
-
setManagedObjectInstance
public void setManagedObjectInstance(String managedObjectInstance)
setManagedObjectInstance
- Parameters:
managedObjectInstance
- aString
object.
-
getManagedObjectType
public String getManagedObjectType()
getManagedObjectType
- Returns:
- a
String
object.
-
setManagedObjectType
public void setManagedObjectType(String managedObjectType)
setManagedObjectType
- Parameters:
managedObjectType
- aString
object.
-
setOssPrimaryKey
public void setOssPrimaryKey(String key)
setOssPrimaryKey
- Parameters:
key
- aString
object.
-
setX733AlarmType
public void setX733AlarmType(String alarmType)
setX733AlarmType
- Parameters:
alarmType
- aString
object.
-
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
- aString
object.
-
getFirstAutomationTime
public Date getFirstAutomationTime()
getFirstAutomationTime
- Returns:
- a
Date
object.
-
setFirstAutomationTime
public void setFirstAutomationTime(Date firstAutomationTime)
setFirstAutomationTime
- Parameters:
firstAutomationTime
- aDate
object.
-
getLastAutomationTime
public Date getLastAutomationTime()
getLastAutomationTime
- Returns:
- a
Date
object.
-
setLastAutomationTime
public void setLastAutomationTime(Date lastAutomationTime)
setLastAutomationTime
- Parameters:
lastAutomationTime
- aDate
object.
-
setDetails
public void setDetails(Map<String,String> alarmDetails)
setDetails
- Parameters:
alarmDetails
- aMap
object.
-
setIfIndex
public void setIfIndex(Integer ifIndex)
setIfIndex
- Parameters:
ifIndex
- aInteger
object.
-
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:
acknowledge
in interfaceAcknowledgeable
- Parameters:
user
- aString
object.
-
unacknowledge
public void unacknowledge(String ackUser)
unacknowledge
- Specified by:
unacknowledge
in interfaceAcknowledgeable
- Parameters:
ackUser
- aString
object.
-
clear
public void clear(String ackUser)
clear
- Specified by:
clear
in interfaceAcknowledgeable
- Parameters:
ackUser
- aString
object.
-
escalate
public void escalate(String ackUser)
escalate
- Specified by:
escalate
in interfaceAcknowledgeable
- Parameters:
ackUser
- aString
object.
-
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:
getType
in interfaceAcknowledgeable
- Returns:
- a
AckType
object.
-
getAckId
public Integer getAckId()
getAckId
- Specified by:
getAckId
in interfaceAcknowledgeable
- Returns:
- a
Integer
object.
-
getAckUser
public String getAckUser()
getAckUser
- Specified by:
getAckUser
in interfaceAcknowledgeable
- Returns:
- a
String
object.
-
getAckTime
public Date getAckTime()
getAckTime
- Specified by:
getAckTime
in interfaceAcknowledgeable
- Returns:
- a
Date
object.
-
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()
-
-