com.neeve.aep
Class AepQuarantineEvent

java.lang.Object
  com.neeve.util.UtlListElement
      com.neeve.event.Event
          com.neeve.aep.AepQuarantineEvent

All Implemented Interfaces:

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

public final class AepQuarantineEvent
extends Event

Event used to drive message quarantine.

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 AepQuarantineEvent	create(MessageView view, IEventAcknowledger acknowledger) Create a new (initialized) quarantine event.
static Event	create(Properties props) Create a new (uninitialized) quarantine event.
MessageView	getMessageView() Get the quarantine message (view).
String	toString() Get a string representation of a quarantine 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) quarantine event.

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

create

public static AepQuarantineEvent create(MessageView view,
                                        IEventAcknowledger acknowledger)

Create a new (initialized) quarantine event.

Parameters:

view - A view of the message to be quarantined.

This method instantiates and initializes a quarantine event. The method uses the packet factory to instantiate a new message evemt (the factory recycles objects through the event type's object pool is configured for the type) and then initializes it with the supplied parameters.

getMessageView

public final MessageView getMessageView()

Get the quarantine message (view).

Threading:

This method is safe for concurrent access by multiple threads.

toString

public final String toString()

Get a string representation of a quarantine event.

Overrides:

toString in class Event