Package org.opennms.netmgt.model

Class OnmsAlarm

    • Field Detail

      • PROBLEM_TYPE

        public static final int PROBLEM_TYPE
        Constant PROBLEM_TYPE=1
        See Also:
        Constant Field Values

      • RESOLUTION_TYPE

        public static final int RESOLUTION_TYPE
        Constant RESOLUTION_TYPE=2
        See Also:
        Constant Field Values

      • PROBLEM_WITHOUT_RESOLUTION_TYPE

        public static final int PROBLEM_WITHOUT_RESOLUTION_TYPE
        Constant PROBLEM_WITHOUT_RESOLUTION_TYPE=3
        See Also:
        Constant Field Values

    • Constructor Detail

      • OnmsAlarm

        public OnmsAlarm()
        default constructor

      • OnmsAlarm

        public OnmsAlarm​(java.lang.Integer alarmid,
                 java.lang.String eventuei,
                 OnmsDistPoller distPoller,
                 java.lang.Integer counter,
                 java.lang.Integer severity,
                 java.util.Date firsteventtime,
                 OnmsEvent event)
        minimal constructor
        Parameters:
        alarmid - a Integer object.
        eventuei - a String object.
        distPoller - a OnmsDistPoller object.
        counter - a Integer object.
        severity - a Integer object.
        firsteventtime - a Date object.
        event - a OnmsEvent object.

    • Method Detail

      • getId

        public java.lang.Integer getId()

        getId

        Returns:
        a Integer object.

      • setId

        public void setId​(java.lang.Integer alarmid)

        setId

        Parameters:
        alarmid - a Integer object.

      • getUei

        public java.lang.String getUei()

        getUei

        Returns:
        a String object.

      • setUei

        public void setUei​(java.lang.String eventuei)

        setUei

        Parameters:
        eventuei - a String object.

      • setNode

        public void setNode​(OnmsNode node)

        setNode

        Parameters:
        node - a OnmsNode object.

      • getNodeId

        public java.lang.Integer getNodeId()

      • getNodeLabel

        public java.lang.String getNodeLabel()

      • getIpAddr

        public java.net.InetAddress getIpAddr()

        getIpAddr

        Returns:
        a String object.

      • setIpAddr

        public void setIpAddr​(java.net.InetAddress ipaddr)

        setIpAddr

        Parameters:
        ipaddr - a String object.

      • getReductionKey

        public java.lang.String getReductionKey()

        getReductionKey

        Returns:
        a String object.

      • setReductionKey

        public void setReductionKey​(java.lang.String reductionkey)

        setReductionKey

        Parameters:
        reductionkey - a String object.

      • getAlarmType

        public java.lang.Integer getAlarmType()

        getAlarmType

        Returns:
        a Integer object.

      • setAlarmType

        public void setAlarmType​(java.lang.Integer alarmtype)

        setAlarmType

        Parameters:
        alarmtype - a Integer object.

      • getCounter

        public java.lang.Integer getCounter()

        getCounter

        Returns:
        a Integer object.

      • setCounter

        public void setCounter​(java.lang.Integer counter)

        setCounter

        Parameters:
        counter - a Integer object.

      • getSeverityLabel

        public java.lang.String getSeverityLabel()

        getSeverityLabel

        Returns:
        a String object.

      • setSeverityLabel

        public void setSeverityLabel​(java.lang.String label)

        setSeverityLabel

        Parameters:
        label - a String object.

      • setSeverity

        public void setSeverity​(OnmsSeverity severity)

        setSeverity

        Parameters:
        severity - a OnmsSeverity object.

      • getSeverityId

        public java.lang.Integer getSeverityId()

        getSeverityId

        Returns:
        a Integer object.

      • setSeverityId

        public void setSeverityId​(java.lang.Integer severity)

        setSeverityId

        Parameters:
        severity - a Integer object.

      • getFirstEventTime

        public java.util.Date getFirstEventTime()

        getFirstEventTime

        Returns:
        a Date object.

      • setFirstEventTime

        public void setFirstEventTime​(java.util.Date firsteventtime)

        setFirstEventTime

        Parameters:
        firsteventtime - a Date object.

      • getDescription

        public java.lang.String getDescription()

        getDescription

        Returns:
        a String object.

      • setDescription

        public void setDescription​(java.lang.String description)

        setDescription

        Parameters:
        description - a String object.

      • getLogMsg

        public java.lang.String getLogMsg()

        getLogMsg

        Returns:
        a String object.

      • setLogMsg

        public void setLogMsg​(java.lang.String logmsg)

        setLogMsg

        Parameters:
        logmsg - a String object.

      • getOperInstruct

        public java.lang.String getOperInstruct()

        getOperInstruct

        Returns:
        a String object.

      • setOperInstruct

        public void setOperInstruct​(java.lang.String operinstruct)

        setOperInstruct

        Parameters:
        operinstruct - a String object.

      • getTTicketId

        public java.lang.String getTTicketId()

        getTTicketId

        Returns:
        a String object.

      • setTTicketId

        public void setTTicketId​(java.lang.String tticketid)

        setTTicketId

        Parameters:
        tticketid - a String object.

      • getMouseOverText

        public java.lang.String getMouseOverText()

        getMouseOverText

        Returns:
        a String object.

      • setMouseOverText

        public void setMouseOverText​(java.lang.String mouseovertext)

        setMouseOverText

        Parameters:
        mouseovertext - a String object.

      • getSuppressedUntil

        public java.util.Date getSuppressedUntil()

        getSuppressedUntil

        Returns:
        a Date object.

      • setSuppressedUntil

        public void setSuppressedUntil​(java.util.Date suppresseduntil)

        setSuppressedUntil

        Parameters:
        suppresseduntil - a Date object.

      • getSuppressedUser

        public java.lang.String getSuppressedUser()

        getSuppressedUser

        Returns:
        a String object.

      • setSuppressedUser

        public void setSuppressedUser​(java.lang.String suppresseduser)

        setSuppressedUser

        Parameters:
        suppresseduser - a String object.

      • getSuppressedTime

        public java.util.Date getSuppressedTime()

        getSuppressedTime

        Returns:
        a Date object.

      • setSuppressedTime

        public void setSuppressedTime​(java.util.Date suppressedtime)

        setSuppressedTime

        Parameters:
        suppressedtime - a Date object.

      • getAlarmAckUser

        public java.lang.String getAlarmAckUser()

        getAlarmAckUser

        Returns:
        a String object.

      • setAlarmAckUser

        public void setAlarmAckUser​(java.lang.String alarmackuser)

        setAlarmAckUser

        Parameters:
        alarmackuser - a String object.

      • isAcknowledged

        public boolean isAcknowledged()

      • getAlarmAckTime

        public java.util.Date getAlarmAckTime()

        getAlarmAckTime

        Returns:
        a Date object.

      • setAlarmAckTime

        public void setAlarmAckTime​(java.util.Date alarmacktime)

        setAlarmAckTime

        Parameters:
        alarmacktime - a Date object.

      • getClearKey

        public java.lang.String getClearKey()

        getClearKey

        Returns:
        a String object.

      • setClearKey

        public void setClearKey​(java.lang.String clearKey)

        setClearKey

        Parameters:
        clearKey - a String object.

      • getLastEvent

        public OnmsEvent getLastEvent()

        getLastEvent

        Returns:
        a OnmsEvent object.

      • setLastEvent

        public void setLastEvent​(OnmsEvent event)

        setLastEvent

        Parameters:
        event - a OnmsEvent object.

      • findEventParameter

        public java.util.Optional<OnmsEventParameter> findEventParameter​(java.lang.String name)

      • getEventParameter

        public java.lang.String getEventParameter​(java.lang.String name)

      • toString

        public java.lang.String toString()

        toString

        Overrides:
        toString in class java.lang.Object
        Returns:
        a String object.

      • getLastEventTime

        public java.util.Date getLastEventTime()

        getLastEventTime

        Returns:
        a Date object.

      • setLastEventTime

        public void setLastEventTime​(java.util.Date lastEventTime)

        setLastEventTime

        Parameters:
        lastEventTime - a Date object.

      • getApplicationDN

        public java.lang.String getApplicationDN()

        getApplicationDN

        Returns:
        a String object.

      • setApplicationDN

        public void setApplicationDN​(java.lang.String applicationDN)

        setApplicationDN

        Parameters:
        applicationDN - a String object.

      • getManagedObjectInstance

        public java.lang.String getManagedObjectInstance()

        getManagedObjectInstance

        Returns:
        a String object.

      • setManagedObjectInstance

        public void setManagedObjectInstance​(java.lang.String managedObjectInstance)

        setManagedObjectInstance

        Parameters:
        managedObjectInstance - a String object.

      • getManagedObjectType

        public java.lang.String getManagedObjectType()

        getManagedObjectType

        Returns:
        a String object.

      • setManagedObjectType

        public void setManagedObjectType​(java.lang.String managedObjectType)

        setManagedObjectType

        Parameters:
        managedObjectType - a String object.

      • getOssPrimaryKey

        public java.lang.String getOssPrimaryKey()

        getOssPrimaryKey

        Returns:
        a String object.

      • setOssPrimaryKey

        public void setOssPrimaryKey​(java.lang.String key)

        setOssPrimaryKey

        Parameters:
        key - a String object.

      • getX733AlarmType

        public java.lang.String getX733AlarmType()

        getX733AlarmType

        Returns:
        a String object.

      • setX733AlarmType

        public void setX733AlarmType​(java.lang.String alarmType)

        setX733AlarmType

        Parameters:
        alarmType - a String object.

      • getX733ProbableCause

        public int getX733ProbableCause()

        getX733ProbableCause

        Returns:
        a int.

      • setX733ProbableCause

        public void setX733ProbableCause​(int cause)

        setX733ProbableCause

        Parameters:
        cause - a int.

      • getQosAlarmState

        public java.lang.String getQosAlarmState()

        getQosAlarmState

        Returns:
        a String object.

      • setQosAlarmState

        public void setQosAlarmState​(java.lang.String alarmState)

        setQosAlarmState

        Parameters:
        alarmState - a String object.

      • getFirstAutomationTime

        public java.util.Date getFirstAutomationTime()

        getFirstAutomationTime

        Returns:
        a Date object.

      • setFirstAutomationTime

        public void setFirstAutomationTime​(java.util.Date firstAutomationTime)

        setFirstAutomationTime

        Parameters:
        firstAutomationTime - a Date object.

      • getLastAutomationTime

        public java.util.Date getLastAutomationTime()

        getLastAutomationTime

        Returns:
        a Date object.

      • setLastAutomationTime

        public void setLastAutomationTime​(java.util.Date lastAutomationTime)

        setLastAutomationTime

        Parameters:
        lastAutomationTime - a Date object.

      • getDetails

        public java.util.Map<java.lang.String,​java.lang.String> getDetails()

        getDetails

        Returns:
        a Map object.

      • setDetails

        public void setDetails​(java.util.Map<java.lang.String,​java.lang.String> alarmDetails)

        setDetails

        Parameters:
        alarmDetails - a Map object.

      • getIfIndex

        public java.lang.Integer getIfIndex()

        getIfIndex

        Returns:
        a Integer object.

      • setIfIndex

        public void setIfIndex​(java.lang.Integer ifIndex)

        setIfIndex

        Parameters:
        ifIndex - a Integer object.

      • getStickyMemo

        public OnmsMemo getStickyMemo()

      • setStickyMemo

        public void setStickyMemo​(OnmsMemo stickyMemo)

      • acknowledge

        public void acknowledge​(java.lang.String user)

        acknowledge

        Specified by:
        acknowledge in interface Acknowledgeable
        Parameters:
        user - a String object.

      • unacknowledge

        public void unacknowledge​(java.lang.String ackUser)

        unacknowledge

        Specified by:
        unacknowledge in interface Acknowledgeable
        Parameters:
        ackUser - a String object.

      • clear

        public void clear​(java.lang.String ackUser)

        clear

        Specified by:
        clear in interface Acknowledgeable
        Parameters:
        ackUser - a String object.

      • escalate

        public void escalate​(java.lang.String ackUser)

        escalate

        Specified by:
        escalate in interface Acknowledgeable
        Parameters:
        ackUser - a String 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()

      • getAckId

        public java.lang.Integer getAckId()

        getAckId

        Specified by:
        getAckId in interface Acknowledgeable
        Returns:
        a Integer object.

      • getAckUser

        public java.lang.String getAckUser()

        getAckUser

        Specified by:
        getAckUser in interface Acknowledgeable
        Returns:
        a String object.

      • getAckTime

        public java.util.Date getAckTime()

        getAckTime

        Specified by:
        getAckTime in interface Acknowledgeable
        Returns:
        a Date object.

      • getRelatedAlarms

        public java.util.Set<OnmsAlarm> getRelatedAlarms()

        getRelatedAlarms

        Returns:
        a Set object.

      • getRelatedAlarmIds

        public java.util.Set<java.lang.Integer> getRelatedAlarmIds()

      • getAssociatedAlarms

        public java.util.Set<AlarmAssociation> getAssociatedAlarms()

      • setAssociatedAlarms

        public void setAssociatedAlarms​(java.util.Set<AlarmAssociation> alarms)

      • setRelatedAlarms

        public void setRelatedAlarms​(java.util.Set<OnmsAlarm> alarms)

      • setRelatedAlarms

        public void setRelatedAlarms​(java.util.Set<OnmsAlarm> alarms,
                             java.util.Date associationEventTime)

      • addRelatedAlarm

        public void addRelatedAlarm​(OnmsAlarm alarm)

      • removeRelatedAlarm

        public void removeRelatedAlarm​(OnmsAlarm alarm)

      • removeRelatedAlarmWithId

        public void removeRelatedAlarmWithId​(java.lang.Integer relatedAlarmId)

      • isSituation

        public boolean isSituation()

      • setSituation

        public void setSituation​(boolean situation)

      • isPartOfSituation

        public boolean isPartOfSituation()

      • setPartOfSituation

        public void setPartOfSituation​(boolean partOfSituation)

      • getRelatedSituations

        public java.util.Set<OnmsAlarm> getRelatedSituations()

      • getRelatedSituationIds

        public java.util.Set<java.lang.Integer> getRelatedSituationIds()

      • setRelatedSituations

        public void setRelatedSituations​(java.util.Set<OnmsAlarm> alarms)

      • getAffectedNodeCount

        public java.lang.Integer getAffectedNodeCount()

      • getLastUpdateTime

        public java.util.Date getLastUpdateTime()