com.neeve.aep.event
Class AepApplicationExceptionEvent

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

All Implemented Interfaces:

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

public final class AepApplicationExceptionEvent
extends AlertEvent

Event notifying an AEP application that an application message handler threw an exception.

Threading:

This class is safe for concurrent access by multiple threads.

This event is dispatched to an application to notify it that the AEP engine trapped an exception thrown by the application.

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) application exception event.
static AepApplicationExceptionEvent	create(Throwable exception, IRogMessage activeMessage) Create a new (initialized) application exception event.
IRogMessage	getActiveMessage() Gets the message that was being processed at the time of the exception.
Throwable	getException() Get the application exception.
MessageView	getTriggeringMessage() Returns the triggering message as specified by IAlertEvent.getTriggeringMessage()..
String	toString() Get a string representation of the object

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

getBackingMessage, getEventTime, 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) application exception event.

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

create

public static AepApplicationExceptionEvent create(Throwable exception,
                                                  IRogMessage activeMessage)

Create a new (initialized) application exception event.

Parameters:

exception - Contains the exception encountered.

activeMessage - the message activeMessage being processed at the time of the exception.

This method instantiates and initializes a application exception event. The method uses the event factory to instantiate a new application exception 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.

getException

public final Throwable getException()

Get the application exception.

Returns:

Returns the exception returned by the failed send.

Threading:

This method is safe for concurrent access by multiple threads.

getActiveMessage

public final IRogMessage getActiveMessage()

Gets the message that was being processed at the time of the exception. The application should not hold onto the message beyond the scope of the event handler without obtaining a reference to it via IStoreObject.acquire().

Returns:

The message that was being processed at the time of the exception, or null if no message exists.

getTriggeringMessage

public final MessageView getTriggeringMessage()

Returns the triggering message as specified by IAlertEvent.getTriggeringMessage()..

This implementation is the same as getActiveMessage().

Specified by:

getTriggeringMessage in interface IAlertEvent

Overrides:

getTriggeringMessage in class AlertEvent

Returns:

The message that was being processed at the time of the exception, or null if no message exists.

toString

public String toString()

Get a string representation of the object

Overrides:

toString in class AlertEvent