com.neeve.aep.event
Class AepMessagingPrestartEvent

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

All Implemented Interfaces:

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

public final class AepMessagingPrestartEvent
extends LifecycleEvent

Event notifying an AEP application that its messaging is about to be 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 is about to start its messaging machinery. This event is dispatched before the engine attempts to establish the application's message bus bindings and join any configured channels.

Field Summary

Fields inherited from class com.neeve.util.UtlListElement

count, head, next, prev

Method Summary

void	addInitialMessage(MessageView initialMessage) Add an initial messages to to be injected into the message stream Initial messages follow the first message (if set) in the order in which they are added to the event object
static AepMessagingPrestartEvent	create() Create a new (initialized) messaging prestart event.
static Event	create(Properties props) Create a new (uninitialized) messaging prestart event.
MessageView	getFirstMessage() Get the first message to be injected into the message stream
List<MessageView>	getInitialMessages() Get the list of initial messages
void	setFirstMessage(MessageView firstMessage) Set the first message to be injected into the message stream
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 prestart event.

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

create

public static AepMessagingPrestartEvent create()

Create a new (initialized) messaging prestart event.

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

setFirstMessage

public final void setFirstMessage(MessageView firstMessage)

Set the first message to be injected into the message stream

getFirstMessage

public final MessageView getFirstMessage()

Get the first message to be injected into the message stream

addInitialMessage

public final void addInitialMessage(MessageView initialMessage)

Add an initial messages to to be injected into the message stream

Initial messages follow the first message (if set) in the order in which they are added to the event object

getInitialMessages

public final List<MessageView> getInitialMessages()

Get the list of initial messages

toString

public String toString()

Get a string representation of the object

Overrides:

toString in class LifecycleEvent