com.neeve.aep.event
Class AepChannelUpEvent

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

All Implemented Interfaces:

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

public final class AepChannelUpEvent
extends LifecycleEvent
implements MessageChannelEvent

Event notifying an AEP application that one of it's channels is online.

Threading:

This class is safe for concurrent access by multiple threads.

This event is dispatched when the AEP engine has successfully connected to the bus containing a channel configured to be of interest to the AEP application (via the engine's configuration descriptor). The event is guaranteed to precede any messages arriving through that channel.

Field Summary

Fields inherited from class com.neeve.util.UtlListElement

count, head, next, prev

Method Summary

static AepChannelUpEvent	create(MessageBusBinding binding, MessageChannel channel) Create a new (initialized) channel up event.
static Event	create(Properties props) Create a new (uninitialized) channel up event.
MessageBusBinding	getMessageBusBinding() Get the bus binding that contains the channel that came online
MessageChannel	getMessageChannel() Get the channel that just came online.
boolean	isLocal() True if the channel event originates from a source that is local.
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) channel up event.

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

create

public static AepChannelUpEvent create(MessageBusBinding binding,
                                       MessageChannel channel)

Create a new (initialized) channel up event.

Parameters:

binding - The binding from where this event originated

channel - The channel that hsa come online

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

getMessageBusBinding

public final MessageBusBinding getMessageBusBinding()

Get the bus binding that contains the channel that came online

Threading:

This method is safe for concurrent access by multiple threads.

getMessageChannel

public final MessageChannel getMessageChannel()

Get the channel that just came online.

Specified by:

getMessageChannel in interface MessageChannelEvent

Threading:

This method is safe for concurrent access by multiple threads.

isLocal

public final boolean isLocal()

True if the channel event originates from a source that is local. Always returns true.

Specified by:

isLocal in interface MessageChannelEvent

Returns:

true if the channel event source is local.

toString

public String toString()

Get a string representation of the object

Overrides:

toString in class LifecycleEvent