com.neeve.aep.event
Class AepStatsAlertEvent

java.lang.Object
  com.neeve.util.UtlListElement
      com.neeve.event.Event
          com.neeve.event.alert.AlertEvent
              com.neeve.aep.event.AepStatsAlertEvent

All Implemented Interfaces:

IAlertEvent, IEvent, UtlPool.Item<Event>, UtlReferenceTracker.HasReferenceTracker

public final class AepStatsAlertEvent
extends AlertEvent

Event notifying an AEP application of a statistics triggered alert.

Threading:

This class is safe for concurrent access by multiple threads.

This event is dispatched to an application of an alert triggered by statistics alert thresholds.

Field Summary

Fields inherited from class com.neeve.util.UtlListElement

count, head, next, prev

Method Summary

static Event	create(Properties props) Create a new (uninitialized) statistics alert event.
static AepStatsAlertEvent	create(String metricName, Object metricValue, Object metricAlertThreshold, IStatsAlert.Type alertType) Create a new (initialized) statistics alert event.
IStatsAlert.Type	getAlertType()
Object	getMetricAlertThreshold()
String	getMetricName()
Object	getMetricValue()
String	toString() Get a string representation of the object

Methods inherited from class com.neeve.event.alert.AlertEvent

getBackingMessage, getEventTime, getTriggeringMessage, setBackingMessage

Methods inherited from class com.neeve.event.Event

acquire, dispose, getAcknowledger, getAttachment, getDelay, getDispatchTime, getInstanceNumber, getOfferTs, getPollTs, getPool, getRemainingTime, getScheduledTime, getSource, getType, init, isEndOfBatch, isHandled, owners, referenceTracker, setAcknowledger, setAttachment, setDelay, setDispatchTime, setEndOfBatch, setHandled, setPool, setScheduledTime, setSource

Methods inherited from class com.neeve.util.UtlListElement

count, insertAfter, insertBefore, isLinked, next, previous, unlink, wipe

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.neeve.event.IEvent

acquire, dispose, getAcknowledger, getAttachment, getDelay, getDispatchTime, getInstanceNumber, getRemainingTime, getScheduledTime, getSource, getType, isEndOfBatch, isHandled, owners, setAcknowledger, setAttachment, setDelay, setEndOfBatch, setHandled, setSource

Methods inherited from interface com.neeve.util.UtlReferenceTracker.HasReferenceTracker

referenceTracker

Method Detail

create

public static Event create(Properties props)

Create a new (uninitialized) statistics alert event.

This method instantiates a new statistics alert event object. The method is for use by the event factory to instantiate new statistics alert events. The method should not be used directly by the user since the method bypasses any event pooling i.e. it creates a new statistics alert event object even if there are eligible event objects available in the event type's pool.

create

public static AepStatsAlertEvent create(String metricName,
                                        Object metricValue,
                                        Object metricAlertThreshold,
                                        IStatsAlert.Type alertType)

Create a new (initialized) statistics alert event.

Parameters:

metricName - The name of the metric that triggered the alert.

metricValue - The value of the metric that triggered the alert.

metricAlertThreshold - The threshold that was offended that triggered the alert

alertType - The type of the alert

This method instantiates and initializes a statistics alert event. The method uses the event factory to instantiate a new statistics alert event (the factory recycles objects through the event type's object pool is configured for the type) and then initializes it with the supplied parameters.

getMetricName

public final String getMetricName()

Returns:

Get the name of the metric that triggered the alert

Threading:

This method is safe for concurrent access by multiple threads.

getMetricValue

public final Object getMetricValue()

Returns:

Get the value of the metric that triggered the alert

Threading:

This method is safe for concurrent access by multiple threads.

getMetricAlertThreshold

public final Object getMetricAlertThreshold()

Returns:

Get the threshold of the metric that triggered the alert

Threading:

This method is safe for concurrent access by multiple threads.

getAlertType

public final IStatsAlert.Type getAlertType()

Returns:

Get the type of the alert

Threading:

This method is safe for concurrent access by multiple threads.

toString

public String toString()

Get a string representation of the object

Overrides:

toString in class AlertEvent