Package org.alfresco.repo.event2

Class EventConsolidator

java.lang.Object

org.alfresco.repo.event2.EventConsolidator

All Implemented Interfaces:

EventSupportedPolicies, NodeServicePolicies.BeforeDeleteNodePolicy, NodeServicePolicies.OnAddAspectPolicy, NodeServicePolicies.OnCreateNodePolicy, NodeServicePolicies.OnMoveNodePolicy, NodeServicePolicies.OnRemoveAspectPolicy, NodeServicePolicies.OnSetNodeTypePolicy, NodeServicePolicies.OnUpdatePropertiesPolicy, ClassPolicy, Policy

public class EventConsolidator
extends Object
implements EventSupportedPolicies

Encapsulates events occurred in a single transaction.

Author:

Jamal Kaabi-Mofrad

Nested Class Summary

Nested classes/interfaces inherited from interface org.alfresco.repo.policy.Policy

Policy.Arg

Field Summary

Fields

Modifier and Type	Field	Description
protected Deque<org.alfresco.repo.event.v1.model.EventType>	eventTypes
protected NodeRef	nodeRef

Fields inherited from interface org.alfresco.repo.node.NodeServicePolicies.BeforeDeleteNodePolicy

QNAME

Fields inherited from interface org.alfresco.repo.node.NodeServicePolicies.OnAddAspectPolicy

QNAME

Fields inherited from interface org.alfresco.repo.node.NodeServicePolicies.OnCreateNodePolicy

QNAME

Fields inherited from interface org.alfresco.repo.node.NodeServicePolicies.OnMoveNodePolicy

QNAME

Fields inherited from interface org.alfresco.repo.node.NodeServicePolicies.OnRemoveAspectPolicy

QNAME

Fields inherited from interface org.alfresco.repo.node.NodeServicePolicies.OnSetNodeTypePolicy

QNAME

Fields inherited from interface org.alfresco.repo.node.NodeServicePolicies.OnUpdatePropertiesPolicy

ARG_0, ARG_1, ARG_2, QNAME

Fields inherited from interface org.alfresco.repo.policy.Policy

NAMESPACE

Constructor Summary

Constructors

Constructor	Description
EventConsolidator(NodeResourceHelper nodeResourceHelper)

Method Summary

Modifier and Type	Method	Description
void	beforeDeleteNode(NodeRef nodeRef)	Called before a node is deleted.
protected org.alfresco.repo.event.v1.model.DataAttributes<org.alfresco.repo.event.v1.model.NodeResource>	buildEventData(EventInfo eventInfo, org.alfresco.repo.event.v1.model.NodeResource resource, org.alfresco.repo.event.v1.model.EventType eventType)
protected org.alfresco.repo.event.v1.model.NodeResource	buildNodeResourceBeforeDelta(org.alfresco.repo.event.v1.model.NodeResource after)
protected void	createBuilderIfAbsent(NodeRef nodeRef)	Creates a builder instance if absent, and sets the required fields.
protected void	createBuilderIfAbsent(NodeRef nodeRef, boolean forceUpdate)	Creates a builder instance if absent or forceUpdate is requested.
List<QName>	getAspectsAdded()
List<QName>	getAspectsRemoved()
Deque<org.alfresco.repo.event.v1.model.EventType>	getEventTypes()
QName	getNodeType()
org.alfresco.repo.event.v1.model.RepoEvent<org.alfresco.repo.event.v1.model.DataAttributes<org.alfresco.repo.event.v1.model.NodeResource>>	getRepoEvent(EventInfo eventInfo)	Builds and returns the RepoEvent instance.
boolean	isResourceBeforeAllFieldsNull()
boolean	isTemporaryNode()	Whether or not the node has been created and then deleted, i.e.
void	onAddAspect(NodeRef nodeRef, QName aspectTypeQName)	Called after an aspect has been added to a node
void	onCreateNode(ChildAssociationRef childAssocRef)	Called when a new node has been created.
void	onMoveNode(ChildAssociationRef oldChildAssocRef, ChildAssociationRef newChildAssocRef)	Called when a node has been moved.
void	onRemoveAspect(NodeRef nodeRef, QName aspectTypeQName)	Called after an aspect has been removed from a node
void	onSetNodeType(NodeRef nodeRef, QName before, QName after)	Called after the type of a node is set explicitly.
void	onUpdateProperties(NodeRef nodeRef, Map<QName,Serializable> before, Map<QName,Serializable> after)	Called after a node's properties have been changed.
protected void	setResourceBeforeAllFieldsNull(boolean resourceBeforeAllFieldsNull)

Methods inherited from class java.lang.Object

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

Field Detail

eventTypes

protected final Deque<org.alfresco.repo.event.v1.model.EventType> eventTypes

nodeRef

protected NodeRef nodeRef

Constructor Detail

EventConsolidator

public EventConsolidator(NodeResourceHelper nodeResourceHelper)

Method Detail

getRepoEvent

public org.alfresco.repo.event.v1.model.RepoEvent<org.alfresco.repo.event.v1.model.DataAttributes<org.alfresco.repo.event.v1.model.NodeResource>> getRepoEvent(EventInfo eventInfo)

Builds and returns the RepoEvent instance.

Parameters:

eventInfo - the object holding the event information

Returns:

the RepoEvent instance

buildEventData

protected org.alfresco.repo.event.v1.model.DataAttributes<org.alfresco.repo.event.v1.model.NodeResource> buildEventData(EventInfo eventInfo,
                                                                                                                        org.alfresco.repo.event.v1.model.NodeResource resource,
                                                                                                                        org.alfresco.repo.event.v1.model.EventType eventType)

createBuilderIfAbsent

protected void createBuilderIfAbsent(NodeRef nodeRef,
                                     boolean forceUpdate)

Creates a builder instance if absent or forceUpdate is requested. It also, sets the required fields.

Parameters:

nodeRef - the nodeRef in the txn

forceUpdate - if true, will get the latest node info and ignores the existing builder object.

createBuilderIfAbsent

protected void createBuilderIfAbsent(NodeRef nodeRef)

Creates a builder instance if absent, and sets the required fields.

Parameters:

nodeRef - the nodeRef in the txn

onCreateNode

public void onCreateNode(ChildAssociationRef childAssocRef)

Description copied from interface: NodeServicePolicies.OnCreateNodePolicy

Called when a new node has been created.

Specified by:

onCreateNode in interface NodeServicePolicies.OnCreateNodePolicy

Parameters:

childAssocRef - the created child association reference

onMoveNode

public void onMoveNode(ChildAssociationRef oldChildAssocRef,
                       ChildAssociationRef newChildAssocRef)

Description copied from interface: NodeServicePolicies.OnMoveNodePolicy

Called when a node has been moved.

Specified by:

onMoveNode in interface NodeServicePolicies.OnMoveNodePolicy

Parameters:

oldChildAssocRef - the child association reference prior to the move

newChildAssocRef - the child association reference after the move

onSetNodeType

public void onSetNodeType(NodeRef nodeRef,
                          QName before,
                          QName after)

Description copied from interface: NodeServicePolicies.OnSetNodeTypePolicy

Called after the type of a node is set explicitly.

Specified by:

onSetNodeType in interface NodeServicePolicies.OnSetNodeTypePolicy

Parameters:

nodeRef - the node that has had its type set.

before - the previous type of the node.

after - the type the node has been given.

onUpdateProperties

public void onUpdateProperties(NodeRef nodeRef,
                               Map<QName,Serializable> before,
                               Map<QName,Serializable> after)

Description copied from interface: NodeServicePolicies.OnUpdatePropertiesPolicy

Called after a node's properties have been changed.

Specified by:

onUpdateProperties in interface NodeServicePolicies.OnUpdatePropertiesPolicy

Parameters:

nodeRef - reference to the updated node

before - the node's properties before the change

after - the node's properties after the change

beforeDeleteNode

public void beforeDeleteNode(NodeRef nodeRef)

Description copied from interface: NodeServicePolicies.BeforeDeleteNodePolicy

Called before a node is deleted.

Specified by:

beforeDeleteNode in interface NodeServicePolicies.BeforeDeleteNodePolicy

Parameters:

nodeRef - the node reference

onAddAspect

public void onAddAspect(NodeRef nodeRef,
                        QName aspectTypeQName)

Description copied from interface: NodeServicePolicies.OnAddAspectPolicy

Called after an aspect has been added to a node

Specified by:

onAddAspect in interface NodeServicePolicies.OnAddAspectPolicy

Parameters:

nodeRef - the node to which the aspect was added

aspectTypeQName - the type of the aspect

onRemoveAspect

public void onRemoveAspect(NodeRef nodeRef,
                           QName aspectTypeQName)

Description copied from interface: NodeServicePolicies.OnRemoveAspectPolicy

Called after an aspect has been removed from a node

Specified by:

onRemoveAspect in interface NodeServicePolicies.OnRemoveAspectPolicy

Parameters:

nodeRef - the node from which the aspect will be removed

aspectTypeQName - the type of the aspect

buildNodeResourceBeforeDelta

protected org.alfresco.repo.event.v1.model.NodeResource buildNodeResourceBeforeDelta(org.alfresco.repo.event.v1.model.NodeResource after)

isTemporaryNode

public boolean isTemporaryNode()

Whether or not the node has been created and then deleted, i.e. a temporary node.

Returns:

true if the node has been created and then deleted, otherwise false

getNodeType

public QName getNodeType()

getEventTypes

public Deque<org.alfresco.repo.event.v1.model.EventType> getEventTypes()

getAspectsAdded

public List<QName> getAspectsAdded()

getAspectsRemoved

public List<QName> getAspectsRemoved()

isResourceBeforeAllFieldsNull

public boolean isResourceBeforeAllFieldsNull()

setResourceBeforeAllFieldsNull

protected void setResourceBeforeAllFieldsNull(boolean resourceBeforeAllFieldsNull)