org.opennms.web.alarm
Class Alarm

java.lang.Object
  org.opennms.web.alarm.Alarm

public class Alarm
extends java.lang.Object

A JavaBean implementation to hold information about a network alarm as defined by OpenNMS.

Author:

Tarus Balog , OpenNMS

Field Summary

protected java.util.Date	acknowledgeTime The time this alarm was acknowledged.
protected java.lang.String	acknowledgeUser The name of the user who acknowledged this alarm.
static int	CLEARED_SEVERITY
protected int	count Reduction count for the alarm, cannot be null
static int	CRITICAL_SEVERITY
protected java.lang.String	description Free-form textual description of the alarm
protected java.lang.String	dpName The dpName of the Dist Poller which received the alarm, cannot be null.
protected java.util.Date	firsteventtime The first time an event was reduced by this alarm
protected int	id Unique identifier for the alarm, cannot be null
static int	INDETERMINATE_SEVERITY
protected java.lang.String	ipAddr IP Address of node's interface
protected int	lastEventID The last event to be reduced by this alarm
protected java.util.Date	lasteventtime The last time an event was reduced by this alarm
protected java.lang.String	logMessage Formatted display text to control how the alarm will appear in the browser.
static int	MAJOR_SEVERITY
static int	MINOR_SEVERITY
protected java.lang.String	mouseOverText Mouse over text.
protected java.lang.Integer	nodeID Unique integer identifier for node, can be null
protected java.lang.String	nodeLabel The human-readable name of the node of this alarm.
static int	NORMAL_SEVERITY
protected java.lang.String	operatorInstruction Operator instruction for event.
protected java.lang.String	parms The <parms> element for this alarm.
protected java.lang.String	reductionKey Reduction key for this alarm, cannot be null
protected java.lang.Integer	serviceID Unique integer identifier of service/poller package, can be null
protected java.lang.String	serviceName Human-readable name of the service
protected int	severity Severity the of alarm.
protected java.util.Date	suppressedTime The time this alarm was suppressed.
protected java.util.Date	suppressedUntil The time that suppression will end for this alarm.
protected java.lang.String	suppressedUser The name of the user who suppressed this alarm.
protected java.lang.String	troubleTicket Trouble ticket integration string.
protected java.lang.Integer	troubleTicketState State of the trouble ticket.
protected java.lang.String	uei Universal Event Identifer (UEI) for this alarm, cannot be null
static int	WARNING_SEVERITY

Constructor Summary

Alarm()
Empty constructor to create an empty Alarm instance.

Alarm(int id, java.lang.String uei, java.lang.String dpName, java.util.Date lasteventtime, java.util.Date firsteventtime, int count, int severity)
Create an alarm that represents a real network alarm with only the required parameters.

Alarm(int id, java.lang.String uei, java.lang.String dpName, java.lang.Integer nodeID, java.lang.String ipAddr, java.lang.Integer serviceID, java.lang.String reductionKey, int count, int severity, int lastEventID, java.util.Date firsteventtime, java.util.Date lasteventtime, java.lang.String description, java.lang.String logMessage, java.lang.String operatorInstruction, java.lang.String troubleTicket, java.lang.Integer troubleTicketState, java.lang.String mouseOverText, java.util.Date suppressedUntil, java.lang.String suppressedUser, java.util.Date suppressedTime, java.lang.String acknowledgeUser, java.util.Date acknowledgeTime, java.lang.String parms)
Create an alarm that represents a real network alarm with all the parameters.

Alarm(int id, java.lang.String uei, java.lang.String dpName, java.lang.Integer nodeID, java.lang.String ipAddr, java.lang.Integer serviceID, java.lang.String reductionKey, int count, int severity, int lastEventID, java.util.Date firsteventtime, java.util.Date lasteventtime, java.lang.String description, java.lang.String logMessage, java.lang.String operatorInstruction, java.lang.String troubleTicket, java.lang.Integer troubleTicketState, java.lang.String mouseOverText, java.util.Date suppressedUntil, java.lang.String suppressedUser, java.util.Date suppressedTime, java.lang.String acknowledgeUser, java.util.Date acknowledgeTime, java.lang.String parms, java.lang.String nodeLabel, java.lang.String serviceName)
Create an alarm that represents a real network alarm with all the parameters.

Method Summary

java.util.Date	getAcknowledgeTime()
java.lang.String	getAcknowledgeUser()
int	getCount()
java.lang.String	getDescription()
java.lang.String	getDpName()
java.util.Date	getFirstEventTime()
int	getId()
java.lang.String	getIpAddress()
int	getLastEventID()
java.util.Date	getLastEventTime()
java.lang.String	getLogMessage()
java.lang.String	getMouseOverText()
int	getNodeId()
java.lang.String	getNodeLabel()
java.lang.String	getOperatorInstruction()
java.lang.String	getParms()
java.lang.String	getReductionKey()
int	getServiceId()
java.lang.String	getServiceName()
int	getSeverity()
java.util.Date	getSuppressedTime()
java.util.Date	getSuppressedUntil()
java.lang.String	getSuppressedUser()
java.lang.String	getTroubleTicket()
java.lang.Integer	getTroubleTicketState()
java.lang.String	getUei()
boolean	isAcknowledged()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INDETERMINATE_SEVERITY

public static final int INDETERMINATE_SEVERITY

See Also:

Constant Field Values

CLEARED_SEVERITY

public static final int CLEARED_SEVERITY

See Also:

Constant Field Values

NORMAL_SEVERITY

public static final int NORMAL_SEVERITY

See Also:

Constant Field Values

WARNING_SEVERITY

public static final int WARNING_SEVERITY

See Also:

Constant Field Values

MINOR_SEVERITY

public static final int MINOR_SEVERITY

See Also:

Constant Field Values

MAJOR_SEVERITY

public static final int MAJOR_SEVERITY

See Also:

Constant Field Values

CRITICAL_SEVERITY

public static final int CRITICAL_SEVERITY

See Also:

Constant Field Values

id

protected int id

Unique identifier for the alarm, cannot be null

uei

protected java.lang.String uei

Universal Event Identifer (UEI) for this alarm, cannot be null

dpName

protected java.lang.String dpName

The dpName of the Dist Poller which received the alarm, cannot be null.

nodeID

protected java.lang.Integer nodeID

Unique integer identifier for node, can be null

ipAddr

protected java.lang.String ipAddr

IP Address of node's interface

serviceID

protected java.lang.Integer serviceID

Unique integer identifier of service/poller package, can be null

reductionKey

protected java.lang.String reductionKey

Reduction key for this alarm, cannot be null

count

protected int count

Reduction count for the alarm, cannot be null

severity

protected int severity

Severity the of alarm.

 
   1  = Indeterminate
   2 = Cleared (unimplemented at this time)
   3 = Warning
   4 = Minor
   5 = Major
   6 = Critical
  
 

lastEventID

protected int lastEventID

The last event to be reduced by this alarm

firsteventtime

protected java.util.Date firsteventtime

The first time an event was reduced by this alarm

lasteventtime

protected java.util.Date lasteventtime

The last time an event was reduced by this alarm

description

protected java.lang.String description

Free-form textual description of the alarm

logMessage

protected java.lang.String logMessage

Formatted display text to control how the alarm will appear in the browser. This field may contain variables that are populated by field values of the message.

operatorInstruction

protected java.lang.String operatorInstruction

Operator instruction for event.

troubleTicket

protected java.lang.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 java.lang.Integer troubleTicketState

State of the trouble ticket. Trouble ticket on/off boolean 1=on, 0=off. Can be null.

mouseOverText

protected java.lang.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.

suppressedUntil

protected java.util.Date suppressedUntil

The time that suppression will end for this alarm.

suppressedUser

protected java.lang.String suppressedUser

The name of the user who suppressed this alarm.

suppressedTime

protected java.util.Date suppressedTime

The time this alarm was suppressed.

acknowledgeUser

protected java.lang.String acknowledgeUser

The name of the user who acknowledged this alarm.

acknowledgeTime

protected java.util.Date acknowledgeTime

The time this alarm was acknowledged.

parms

protected java.lang.String parms

The <parms> element for this alarm.

serviceName

protected java.lang.String serviceName

Human-readable name of the service

nodeLabel

protected java.lang.String nodeLabel

The human-readable name of the node of this alarm. Can be null.

Constructor Detail

Alarm

public Alarm()

Empty constructor to create an empty Alarm instance. All fields will hold the default values.

Alarm

public Alarm(int id,
             java.lang.String uei,
             java.lang.String dpName,
             java.util.Date lasteventtime,
             java.util.Date firsteventtime,
             int count,
             int severity)

Create an alarm that represents a real network alarm with only the required parameters.

Alarm

public Alarm(int id,
             java.lang.String uei,
             java.lang.String dpName,
             java.lang.Integer nodeID,
             java.lang.String ipAddr,
             java.lang.Integer serviceID,
             java.lang.String reductionKey,
             int count,
             int severity,
             int lastEventID,
             java.util.Date firsteventtime,
             java.util.Date lasteventtime,
             java.lang.String description,
             java.lang.String logMessage,
             java.lang.String operatorInstruction,
             java.lang.String troubleTicket,
             java.lang.Integer troubleTicketState,
             java.lang.String mouseOverText,
             java.util.Date suppressedUntil,
             java.lang.String suppressedUser,
             java.util.Date suppressedTime,
             java.lang.String acknowledgeUser,
             java.util.Date acknowledgeTime,
             java.lang.String parms)

Create an alarm that represents a real network alarm with all the parameters.

Alarm

public Alarm(int id,
             java.lang.String uei,
             java.lang.String dpName,
             java.lang.Integer nodeID,
             java.lang.String ipAddr,
             java.lang.Integer serviceID,
             java.lang.String reductionKey,
             int count,
             int severity,
             int lastEventID,
             java.util.Date firsteventtime,
             java.util.Date lasteventtime,
             java.lang.String description,
             java.lang.String logMessage,
             java.lang.String operatorInstruction,
             java.lang.String troubleTicket,
             java.lang.Integer troubleTicketState,
             java.lang.String mouseOverText,
             java.util.Date suppressedUntil,
             java.lang.String suppressedUser,
             java.util.Date suppressedTime,
             java.lang.String acknowledgeUser,
             java.util.Date acknowledgeTime,
             java.lang.String parms,
             java.lang.String nodeLabel,
             java.lang.String serviceName)

Create an alarm that represents a real network alarm with all the parameters.

Method Detail

getId

public int getId()

getUei

public java.lang.String getUei()

getDpName

public java.lang.String getDpName()

getLastEventTime

public java.util.Date getLastEventTime()

getFirstEventTime

public java.util.Date getFirstEventTime()

getCount

public int getCount()

getSeverity

public int getSeverity()

getNodeId

public int getNodeId()

getIpAddress

public java.lang.String getIpAddress()

getServiceId

public int getServiceId()

getReductionKey

public java.lang.String getReductionKey()

getLastEventID

public int getLastEventID()

getDescription

public java.lang.String getDescription()

getLogMessage

public java.lang.String getLogMessage()

getOperatorInstruction

public java.lang.String getOperatorInstruction()

getTroubleTicket

public java.lang.String getTroubleTicket()

getTroubleTicketState

public java.lang.Integer getTroubleTicketState()

getMouseOverText

public java.lang.String getMouseOverText()

getSuppressedUntil

public java.util.Date getSuppressedUntil()

getSuppressedUser

public java.lang.String getSuppressedUser()

getSuppressedTime

public java.util.Date getSuppressedTime()

getAcknowledgeUser

public java.lang.String getAcknowledgeUser()

getAcknowledgeTime

public java.util.Date getAcknowledgeTime()

isAcknowledged

public boolean isAcknowledged()

getParms

public java.lang.String getParms()

getNodeLabel

public java.lang.String getNodeLabel()

getServiceName

public java.lang.String getServiceName()