Package COM.TIBCO.hawk.console.hawkeye

Class AlertMonitorEvent

java.lang.Object

java.util.EventObject

COM.TIBCO.hawk.console.hawkeye.MonitorEvent

COM.TIBCO.hawk.console.hawkeye.RuleBaseMonitorEvent

COM.TIBCO.hawk.console.hawkeye.AlertMonitorEvent

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ClearAlertEvent, PostAlertEvent

public abstract class AlertMonitorEvent
extends RuleBaseMonitorEvent

The root class for all alert related events.

The sub-classes of this class are:

• PostAlertEvent - generated when alerts are posted
• ClearAlertEvent - generated when alerts are cleared.

Alerts are posted and cleared by rulebases which are loaded in an agent's rulebase engine. AlertMonitorEvents, therefore, can be considered to have two logical sources:

• the rulebase that generated them (See RuleBaseMonitorEvent.getRuleBaseStatus()) and
• the agent that rulebase is loaded on (See MonitorEvent.getAgentInstance()).

See Also:

• AlertMonitorListener
• AgentInstance
• MonitorEvent.getAgentInstance()
• RuleBaseMonitorEvent.getRuleBaseStatus()
• Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Method Summary

Modifier and Type	Method	Description
long	getAlertID()	Retrieves the alert id associated whith this particular event.
int	getRuleBaseEngineState()	Returns rulebase engine state at the time this event was generated.
long	getTimeGenerated()	Retrieves the time this event was generated relative to the source agent's system clock.
static int	mapAlertState(int nestAlertState)
boolean	ruleBaseEngineStateChanged()	Indicates whether or not this event caused a change in the state of the rulebase engine of the agent from which it originiated.
boolean	ruleBaseStateChanged()	Indicates whether or not this event caused a change in the state of the rulebase that generated it.

Methods inherited from class COM.TIBCO.hawk.console.hawkeye.RuleBaseMonitorEvent

getRuleBaseStatus

Methods inherited from class COM.TIBCO.hawk.console.hawkeye.MonitorEvent

getAgentInstance

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Method Details

getAlertID

public long getAlertID()

Retrieves the alert id associated whith this particular event.

Returns:

the alert id associated with this event.

getTimeGenerated

public long getTimeGenerated()

Retrieves the time this event was generated relative to the source agent's system clock.

Returns:

time event was generated relative to the source agent's system clock.

ruleBaseStateChanged

public boolean ruleBaseStateChanged()

Indicates whether or not this event caused a change in the state of the rulebase that generated it. The alert state of a rulebase is the highest alert state of all of its still active (i.e. not cleared) posted alerts. Only AlertMonitorEvents may change the state of a rulebase. A PostAlertEvent can potentialy increase the alert state of a rulebase. A ClearAlertEvent can potentially decrease the alert state of a rulebase.

Returns:

true if this event caused the rulebase state to change.

ruleBaseEngineStateChanged

public boolean ruleBaseEngineStateChanged()

Indicates whether or not this event caused a change in the state of the rulebase engine of the agent from which it originiated. The rulebase engine's state is defined as the highest alert state of all the currently loaded and active rulebases. Because an AlertMonitorEvent can change the state of a rulebase, they may also effect the state of the rulebase engine.

Returns:

true if this event caused the rulebase engine state to change.

getRuleBaseEngineState

public int getRuleBaseEngineState()

Returns rulebase engine state at the time this event was generated. Rulebase states may be mapped with the constants defined in AlertState

Returns:

the rulebase engine state at the time this event was generated.

See Also:

• AlertState

mapAlertState

public static int mapAlertState(int nestAlertState)