com.neeve.aep.event

Class AepMessageTraceLoggingExceptionEvent

java.lang.Object

com.neeve.util.UtlListElement

com.neeve.event.Event

com.neeve.event.alert.AlertEvent

com.neeve.aep.event.AepMessageTraceLoggingExceptionEvent

All Implemented Interfaces:

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

public final class AepMessageTraceLoggingExceptionEvent
extends AlertEvent

Event notifying an AEP application that a message trace logging exception has been trapped.

Threading:

This class is safe for concurrent access by multiple threads.

This event is dispatched to an application to notify that a message trace logging exception has been trapped.

Field Summary

Fields inherited from class com.neeve.util.UtlListElement

count, head, next, prev

Method Summary

Modifier and Type	Method and Description
static Event	create(Properties props) Create a new (uninitialized) message trace logging exception event.
static AepMessageTraceLoggingExceptionEvent	create(String operation, Throwable exception, IRogMessage triggeringMessage) Create a new (initialized) message trace logging exception event.
Throwable	getException() Get the trapped message trace logging exception.
String	getOperation() Get a description of the message trace logging operation that resulted in the trapped 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) message trace logging exception event.

This method instantiates a new message trace logging exception event object. The method is for use by the event factory to instantiate new trapped 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 message trace logging exception event object even if there are eligible event objects available in the event type's pool.

create

public static AepMessageTraceLoggingExceptionEvent create(String operation,
                                                          Throwable exception,
                                                          IRogMessage triggeringMessage)

Create a new (initialized) message trace logging exception event.

Parameters:

operation - The (human readable) operation that was being performed that caused the exception.

exception - Contains the exception encountered.

triggeringMessage - the message that triggered this exception (if applicable).

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

getOperation

public final String getOperation()

Get a description of the message trace logging operation that resulted in the trapped exception.

Returns:

The operation that caused the trapped exception.

getException

public final Throwable getException()

Get the trapped message trace logging exception.

Returns:

Returns the exception returned by the failed operation.

Threading:

This method is safe for concurrent access by multiple threads.

getTriggeringMessage

public final MessageView getTriggeringMessage()

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

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