com.neeve.aep.event
Class AepOutboundLogExceptionEvent

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

All Implemented Interfaces:

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

public final class AepOutboundLogExceptionEvent
extends AlertEvent

Event notifying an AEP application that a write to the outbound log operation failed.

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 encountered an exception when writing to an outbound message log. This event is only dispatched by engines configured to log outbound messages in a log different from the recovery log.

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) outbound log exception event.
static AepOutboundLogExceptionEvent	create(Throwable exception, MessageView triggeringMessage) Create a new (initialized) outbound log exception event.
Throwable	getException() Get the outbound log 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) outbound log exception event.

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

create

public static AepOutboundLogExceptionEvent create(Throwable exception,
                                                  MessageView triggeringMessage)

Create a new (initialized) outbound log exception event.

Parameters:

exception - Contains the exception encountered.

triggeringMessage - The message that triggered the logging exception (or null if not caused by a particular message).

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

Returns:

Returns the exception returned by the failed send.

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().

If this event is triggered by a failure to log a particular message then this method will return that message, otherwise if this is caused by some other outbound logging exception such a flushing several messages to the log, then this method may return null.

Specified by:

getTriggeringMessage in interface IAlertEvent

Overrides:

getTriggeringMessage in class AlertEvent

Returns:

The message that triggered the logging failure or null if not triggered by a single message.

See Also:

IAlertEvent.getTriggeringMessage()

toString

public String toString()

Get a string representation of the object

Overrides:

toString in class AlertEvent