com.neeve.aep.event
Class AepMessagingStartedEvent

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

All Implemented Interfaces:

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

public final class AepMessagingStartedEvent
extends LifecycleEvent

Event notifying an AEP application that its messaging has been started.

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 started its messaging machinery. This event is dispatched after the engine has attempted to establish the application's message bus bindings and join any configured channels. For bindings that were successfully established, the application would have received the corresponding channel up events before this event is dispatched.

Field Summary

Fields inherited from class com.neeve.util.UtlListElement

count, head, next, prev

Method Summary

static AepMessagingStartedEvent	create(Exception status) Create a new (initialized) messaging started event.
static Event	create(Properties props) Create a new (uninitialized) messaging started event.
Exception	getStatus() Get messaging start completion status.
void	setStatus(Exception status) Set messaging start completion status.
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.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 started event.

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

create

public static AepMessagingStartedEvent create(Exception status)

Create a new (initialized) messaging started event.

Parameters:

status - Contains the messaging start status. A null value indicates a successful status while a non-null value indicates failure. How a messaging start operation is deemed a success or failure is determined by the engine's messaging start fail policy. Furthermore, the policy determines how to interpret a non-value returned here. For NeverFail policy, a non-null status indicates that all binding attempts returned with a permanent exception. In such as case, this parameter contains the permanent exception returned by the last binding attempt. For the FailIfOneBindingFails policy, a non-null status indicates that at least one binding attempt failed. In such a case, this parameter is the exeption returned by the failed binding attempt. Finally, for FailIfAllBindingsFail, a non-null status indicates that all binding attempts failed (not necessarily permanent). In such a case, this parameter contains the exception returned by the last failed attempt.

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

setStatus

public final void setStatus(Exception status)

Set messaging start completion status.

Parameters:

status - The completion status to set.

Threading:

This method is safe for concurrent access by multiple threads.

getStatus

public final Exception getStatus()

Get messaging start completion status.

Returns:

Returns null if the messaging start operation completed successfully or non-null if otherwise. See create(java.util.Properties) for how to interpret the value returned by this method.

Threading:

This method is safe for concurrent access by multiple threads.

toString

public String toString()

Get a string representation of the object

Overrides:

toString in class LifecycleEvent