com.neeve.event.alert
Interface IAlertEvent

All Superinterfaces:
IEvent, UtlReferenceTracker.HasReferenceTracker
All Known Subinterfaces:
IStoreAlertEvent, IStoreBindingFailedEvent, IStoreMemberDownEvent, IStoreTransactionLogRepairedEvent
All Known Implementing Classes:
AepApplicationExceptionEvent, AepBusBindingCreateFailedEvent, AepBusBindingDownEvent, AepBusBindingOpenFailedEvent, AepChannelDownEvent, AepDuplicateAcknowledgementAlertEvent, AepEngineStoppedEvent, AepEngineStoppingEvent, AepInboundLogExceptionEvent, AepMessageTraceLoggingExceptionEvent, AepMessagingFailedEvent, AepMessagingStartFailedEvent, AepOutboundLogExceptionEvent, AepOutOfOrderSendCommitCompletionAlertEvent, AepSendExceptionEvent, AepStatsAlertEvent, AepStuckAlertEvent, AepUnhandledMessageEvent, AlertEvent, MessageBusBindingReconnectedEvent, MessageBusBindingReconnectingEvent, UnhandledMessageEvent

public interface IAlertEvent
extends IEvent

Represents an alert event

Threading:
This class is not safe for concurrent access by multiple threads.

Method Summary
 MessageView getBackingMessage()
          Get the message view backing an alert event
 long getEventTime()
          Get the time the event occurred
 MessageView getTriggeringMessage()
          Get the message that triggered the alert.
 void setBackingMessage(MessageView view)
          Set the message view backing an alert event Note: This method takes ownership of the set message view i.e.
 
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

getEventTime

long getEventTime()
Get the time the event occurred


setBackingMessage

void setBackingMessage(MessageView view)
Set the message view backing an alert event

Note: This method takes ownership of the set message view i.e. it will dispose it when the event is disposed.


getBackingMessage

MessageView getBackingMessage()
Get the message view backing an alert event


getTriggeringMessage

MessageView getTriggeringMessage()
Get the message that triggered the alert.

Applications must not hold onto the message beyond the scope of the event handler without obtaining a reference to it via MessageView.acquire().

Applications must treat this message as read only, and must not call any mutator method on the message.

Returns:
A value of null indicates that the alert was not triggered by any inbound or outbound message.


Copyright © 2016 Neeve Research, LLC. All Rights Reserved.