atg.markers
Class MarkerEventSynchronization

java.lang.Object
  atg.markers.MarkerEventSynchronization

All Implemented Interfaces:

javax.transaction.Synchronization

public class MarkerEventSynchronization
extends java.lang.Object
implements javax.transaction.Synchronization

This transaction synchronization class can be used to send marker event messages after markers are successfully added and or removed. Instances of this class are created by the RepositoryMarkerManager and attached to the current transaction when markers are added or removed.

See Also:

RepositoryMarkerManager

Field Summary

static java.lang.String	CLASS_VERSION Class version string
protected java.util.List	mAddedMarkerEvents
protected java.util.List	mRemovedMarkerEvents
protected java.util.List	mReplacedMarkerEvents
protected RepositoryMarkerManager	mRepositoryMarkerManager

Constructor Summary

MarkerEventSynchronization(RepositoryMarkerManager pRepositoryMarkerManager, java.util.List pAddedMarkerEvents, java.util.List pRemovedMarkerEvents, java.util.List pReplacedMarkerEvents)
Constructs a new MarkerEventSyncronization object.

Method Summary

void	afterCompletion(int pStatus) This method sends MarkerRemovedEventMessage, MarkerRemovedEventMessage and MarkerRemovedEventMessage messages through the Repository Marker Manager's MarkerMessageSource.
void	beforeCompletion() Dummy implementation of beforeCompletion
java.util.List	getAddedMarkerEvents() Returns property AddedMarkerEvents
java.util.List	getRemovedMarkerEvents() Returns property RemovedMarkerEvents
java.util.List	getReplacedMarkerEvents() Returns property ReplacedMarkerEvents
RepositoryMarkerManager	getRepositoryMarkerManager() Returns property RepositoryMarkerManager
void	setAddedMarkerEvents(java.util.List pAddedMarkerEvents) Sets the list of MarkerEventMessages for markers that have been added
void	setRemovedMarkerEvents(java.util.List pRemovedMarkerEvents) Sets the list of MarkerEventMessages for items that have been removed
void	setReplacedMarkerEvents(java.util.List pReplacedMarkerEvents) Sets the list of MarkerEventMessages for items that have been replaced
void	setRepositoryMarkerManager(RepositoryMarkerManager pRepositoryMarkerManager) Sets the instance of RepositoryMarkerManager that created the instance of this object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

mRepositoryMarkerManager

protected RepositoryMarkerManager mRepositoryMarkerManager

mReplacedMarkerEvents

protected java.util.List mReplacedMarkerEvents

mRemovedMarkerEvents

protected java.util.List mRemovedMarkerEvents

mAddedMarkerEvents

protected java.util.List mAddedMarkerEvents

Constructor Detail

MarkerEventSynchronization

public MarkerEventSynchronization(RepositoryMarkerManager pRepositoryMarkerManager,
                                  java.util.List pAddedMarkerEvents,
                                  java.util.List pRemovedMarkerEvents,
                                  java.util.List pReplacedMarkerEvents)

Constructs a new MarkerEventSyncronization object.

Parameters:

pRepositoryMarkerManager - the repository marker manager that is triggering the events.

pAddedMarkerEvents - the list of marker added events.

pRemovedMarkerEvents - the list of marker removed events.

pReplacedMarkerEvents - the list of marker replaced events.

Method Detail

setRepositoryMarkerManager

public void setRepositoryMarkerManager(RepositoryMarkerManager pRepositoryMarkerManager)

Sets the instance of RepositoryMarkerManager that created the instance of this object. It provides the message source and JMS message types.

getRepositoryMarkerManager

public RepositoryMarkerManager getRepositoryMarkerManager()

Returns property RepositoryMarkerManager

setReplacedMarkerEvents

public void setReplacedMarkerEvents(java.util.List pReplacedMarkerEvents)

Sets the list of MarkerEventMessages for items that have been replaced

getReplacedMarkerEvents

public java.util.List getReplacedMarkerEvents()

Returns property ReplacedMarkerEvents

setRemovedMarkerEvents

public void setRemovedMarkerEvents(java.util.List pRemovedMarkerEvents)

Sets the list of MarkerEventMessages for items that have been removed

getRemovedMarkerEvents

public java.util.List getRemovedMarkerEvents()

Returns property RemovedMarkerEvents

setAddedMarkerEvents

public void setAddedMarkerEvents(java.util.List pAddedMarkerEvents)

Sets the list of MarkerEventMessages for markers that have been added

getAddedMarkerEvents

public java.util.List getAddedMarkerEvents()

Returns property AddedMarkerEvents

afterCompletion

public void afterCompletion(int pStatus)

This method sends MarkerRemovedEventMessage, MarkerRemovedEventMessage and MarkerRemovedEventMessage messages through the Repository Marker Manager's MarkerMessageSource.

A jms message is triggered for each marker event message in the removeMarkerEvents, replacedMarkerEvents and addMarkerEvents lists.

The JMS type used for each type of message is defined by the RepositoryMarkerManager.

pStatus must be STATUS_COMMITTED for messages to be triggered.

Specified by:

afterCompletion in interface javax.transaction.Synchronization

Parameters:

pStatus - - transaction completion status.

beforeCompletion

public void beforeCompletion()

Dummy implementation of beforeCompletion

Specified by:

beforeCompletion in interface javax.transaction.Synchronization