com.neeve.aep.event
Class AepEngineStoppedEvent

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

All Implemented Interfaces:

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

public final class AepEngineStoppedEvent
extends LifecycleEvent
implements IAlertEvent

Event notifying an AEP application that its engine has stopped.

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 been stopped.

Field Summary

Fields inherited from class com.neeve.util.UtlListElement

count, head, next, prev

Method Summary

static AepEngineStoppedEvent	create(Exception cause) Create a new (initialized) engine stopped event.
static Event	create(Properties props) Create a new (uninitialized) engine stopped event.
Exception	getCause() Get the reason for the stop.
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) engine stopped event.

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

create

public static AepEngineStoppedEvent create(Exception cause)

Create a new (initialized) engine stopped event.

Parameters:

cause - Specifies the reason why the engine is stopped. A null value indicates a graceful stop.

This method instantiates and initializes a engine stopped event. The method uses the event factory to instantiate a new engine stopped 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 reason for the stop.

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