com.neeve.aep.event

Class AepTransactionStageEvent

java.lang.Object

com.neeve.util.UtlListElement

com.neeve.event.Event

com.neeve.aep.event.AepTransactionStageEvent

All Implemented Interfaces:

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

public final class AepTransactionStageEvent
extends Event

Event notifying an AEP application of reaching a stage in a transaction commit.

Threading:

This class is safe for concurrent access by multiple threads.

This event is dispatched to notify an application when a stage has been reached in a transaction commit workflow.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AepTransactionStageEvent.ICommitContext Represents the context of an ongoing transaction commit.
static class	AepTransactionStageEvent.TransactionStage Lists the various transaction stages

Field Summary

Fields inherited from class com.neeve.util.UtlListElement

count, head, next, prev

Method Summary

Modifier and Type	Method and Description
static AepTransactionStageEvent	create(AepTransactionStageEvent.ICommitContext context, AepTransactionStageEvent.TransactionStage stage) Create a new (initialized) transaction stage event.
static Event	create(Properties props) Create a new (uninitialized) transaction stage event.
AepTransactionStageEvent.ICommitContext	getCommitContext() Get the commit context.
AepTransactionStageEvent.TransactionStage	getStage() Get the transaction stage represented by this event
boolean	getSuspend() Get whether an event is marked to suspend a transaction.
void	setSuspend(boolean val) Set whether the transaction should be suspended.
String	toString() Get a string representation of the object

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) transaction stage event.

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

create

public static AepTransactionStageEvent create(AepTransactionStageEvent.ICommitContext context,
                                              AepTransactionStageEvent.TransactionStage stage)

Create a new (initialized) transaction stage event.

Parameters:

context - The transaction commit context.

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

getCommitContext

public final AepTransactionStageEvent.ICommitContext getCommitContext()

Get the commit context.

Threading:

This method is safe for concurrent access by multiple threads.

getStage

public final AepTransactionStageEvent.TransactionStage getStage()

Get the transaction stage represented by this event

Threading:

This method is safe for concurrent access by multiple threads.

setSuspend

public final void setSuspend(boolean val)

Set whether the transaction should be suspended.

Throws:

IllegalStateException - Thrown if this method is invoked on an event representing a stage other than the Start stage

Threading:

This method is safe for concurrent access by multiple threads.

An application should invoke this method in case it wishes for the transaction represented by this event to be suspended when the event dispatch call returns to the AEP engine. If set to suspend, the application needs to resume the transaction commit via the AepEngine.resumeCommit method.

getSuspend

public final boolean getSuspend()

Get whether an event is marked to suspend a transaction.

Threading:

This method is safe for concurrent access by multiple threads.

toString

public String toString()

Get a string representation of the object

Overrides:

toString in class Event