com.neeve.aep.event
Class AepMessagingFailedEvent

java.lang.Object
  com.neeve.util.UtlListElement
      com.neeve.event.Event
          com.neeve.event.lifecycle.LifecycleEvent
              com.neeve.aep.event.AepMessagingFailedEvent

All Implemented Interfaces:

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

public final class AepMessagingFailedEvent
extends LifecycleEvent
implements IAlertEvent

Event notifying an AEP application that its messaging has 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 has shut down its messaging due to a failure. This event is dispatched after the engine has shut down all the established message bus bindings. Whether and how an engine decides to shut down the messaging is determined by the AepEngine.MessageBusBindingFailPolicy

Field Summary

Fields inherited from class com.neeve.util.UtlListElement

count, head, next, prev

Method Summary

static AepMessagingFailedEvent	create(Exception cause) Create a new (initialized) messaging failed event.
static Event	create(Properties props) Create a new (uninitialized) messaging failed event.
Exception	getCause() Get the cause of messaging failure.
MessageView	getTriggeringMessage() Implementation of IAlertEvent.getTriggeringMessage()
String	toString() Get a string representation of the object

Methods inherited from class com.neeve.event.lifecycle.LifecycleEvent

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.alert.IAlertEvent

getBackingMessage, getEventTime, setBackingMessage

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) messaging failed event.

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

create

public static AepMessagingFailedEvent create(Exception cause)

Create a new (initialized) messaging failed event.

Parameters:

cause - Contains the cause of messaging failure.

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

getCause

public final Exception getCause()

Get the cause of messaging failure.

Threading:

This method is safe for concurrent access by multiple threads.

getTriggeringMessage

public final MessageView getTriggeringMessage()

Implementation of IAlertEvent.getTriggeringMessage()

Specified by:

getTriggeringMessage in interface IAlertEvent

Returns:

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

toString

public String toString()

Get a string representation of the object

Overrides:

toString in class LifecycleEvent