com.neeve.aep.event
Class AepChannelDownEvent

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

All Implemented Interfaces:

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

public final class AepChannelDownEvent
extends LifecycleEvent
implements MessageChannelEvent, IAlertEvent

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

Threading:

This class is safe for concurrent access by multiple threads.

This event is dispatched when the AEP engine has successfully disconnected from 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 succeed any messages arriving through that channel.

Field Summary

Fields inherited from class com.neeve.util.UtlListElement

count, head, next, prev

Method Summary

static AepChannelDownEvent	create(MessageBusBinding binding, MessageChannel channel) Create a new (initialized) channel down event.
static Event	create(Properties props) Create a new (uninitialized) channel down event.
MessageBusBinding	getMessageBusBinding() Get the bus binding that contains the channel that went offline.
MessageChannel	getMessageChannel() Get the channel that went offline.
MessageView	getTriggeringMessage() Implementation of IAlertEvent.getTriggeringMessage()
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.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) channel down event.

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

create

public static AepChannelDownEvent create(MessageBusBinding binding,
                                         MessageChannel channel)

Create a new (initialized) channel down event.

Parameters:

binding - The binding from where this event originated

channel - The channel that hsa come online

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

Threading:

This method is safe for concurrent access by multiple threads.

getMessageChannel

public final MessageChannel getMessageChannel()

Get the channel that went offline.

Specified by:

getMessageChannel in interface MessageChannelEvent

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.

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