com.neeve.sma.event
Class MessageStabilityEvent

java.lang.Object
  com.neeve.util.UtlListElement
      com.neeve.event.Event
          com.neeve.sma.event.MessageStabilityEvent

All Implemented Interfaces:

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

public class MessageStabilityEvent
extends Event
implements MessageChannelEvent

Event notifying the delivery stability of a message.

Threading:

This class is safe for concurrent access by multiple threads.

Field Summary

Fields inherited from class com.neeve.util.UtlListElement

count, head, next, prev

Method Summary

static MessageStabilityEvent	create(MessageBusBinding binding, MessageChannel channel, MessageView view, Exception status) Create a new (initialized) message stability event.
static Event	create(Properties props) Create a new (uninitialized) message stability event.
MessageChannel	getMessageChannel() Get the channel associated with a stability event.
MessageView	getMessageView() Get the stabilized message.
Exception	getStatus() Get the stabilization status.
boolean	isLocal() True if the channel event originates from a source that is local.
String	toString() Get a string representation of a message stability event.

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

Method Detail

create

public static Event create(Properties props)

Create a new (uninitialized) message stability event.

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

create

public static MessageStabilityEvent create(MessageBusBinding binding,
                                           MessageChannel channel,
                                           MessageView view,
                                           Exception status)

Create a new (initialized) message stability event.

Parameters:

binding - The binding from where this event originated

channel - The channel through which the stabilized message was sent.

view - The stabilized message view.

status - The message stabilization status.

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

getMessageChannel

public final MessageChannel getMessageChannel()

Get the channel associated with a stability event.

Specified by:

getMessageChannel in interface MessageChannelEvent

Threading:

This method is safe for concurrent access by multiple threads.

getMessageView

public final MessageView getMessageView()

Get the stabilized message.

Threading:

This method is safe for concurrent access by multiple threads.

This method returns the message view supplied to the channel send method that this event corresponds to.

getStatus

public final Exception getStatus()

Get the stabilization status.

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. Stability event are not considered to be local. This method always returns false.

Specified by:

isLocal in interface MessageChannelEvent

Returns:

true if the channel event source is local.

toString

public String toString()

Get a string representation of a message stability event.

Overrides:

toString in class Event