Package org.alfresco.repo.event2

Class EventGenerator

java.lang.Object

org.springframework.extensions.surf.util.AbstractLifecycleBean

org.alfresco.repo.event2.EventGenerator

All Implemented Interfaces:

EventListener, ChildAssociationEventSupportedPolicies, EventSupportedPolicies, PeerAssociationEventSupportedPolicies, NodeServicePolicies.BeforeDeleteAssociationPolicy, NodeServicePolicies.BeforeDeleteChildAssociationPolicy, NodeServicePolicies.BeforeDeleteNodePolicy, NodeServicePolicies.OnAddAspectPolicy, NodeServicePolicies.OnCreateAssociationPolicy, NodeServicePolicies.OnCreateChildAssociationPolicy, NodeServicePolicies.OnCreateNodePolicy, NodeServicePolicies.OnMoveNodePolicy, NodeServicePolicies.OnRemoveAspectPolicy, NodeServicePolicies.OnSetNodeTypePolicy, NodeServicePolicies.OnUpdatePropertiesPolicy, AssociationPolicy, ClassPolicy, Policy, org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationListener

public class EventGenerator
extends org.springframework.extensions.surf.util.AbstractLifecycleBean
implements org.springframework.beans.factory.InitializingBean, EventSupportedPolicies, ChildAssociationEventSupportedPolicies, PeerAssociationEventSupportedPolicies

Generates events and sends them to an event topic.

Author:

Jamal Kaabi-Mofrad

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	EventGenerator.Consolidators
protected class	EventGenerator.EventTransactionListener

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

Policy.Arg

Field Summary

Fields

Modifier and Type	Field	Description
protected DictionaryService	dictionaryService
protected boolean	enabled
protected NodeDAO	nodeDAO
protected NodeResourceHelper	nodeResourceHelper
protected NodeService	nodeService
protected PolicyComponent	policyComponent
protected final EventGenerator.EventTransactionListener	transactionListener

Fields inherited from class org.springframework.extensions.surf.util.AbstractLifecycleBean

log

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

QNAME

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

QNAME

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.OnCreateAssociationPolicy

QNAME

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

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
EventGenerator()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
void	beforeDeleteAssociation(AssociationRef associationRef)	Called before a regular node association is deleted.
void	beforeDeleteChildAssociation(ChildAssociationRef childAssociationRef)	Called before a node child association is deleted.
void	beforeDeleteNode(NodeRef nodeRef)	Called before a node is deleted.
protected Behaviour	bindAssociationBehaviour(QName policyQName, String method)
protected Behaviour	bindClassBehaviour(QName policyQName, String method)
protected ChildAssociationEventConsolidator	createChildAssociationEventConsolidator(ChildAssociationRef childAssociationRef)
protected NodeEventConsolidator	createEventConsolidator()
protected PeerAssociationEventConsolidator	createPeerAssociationEventConsolidator(AssociationRef peerAssociationRef)
void	disable()	Disable Events2 generated events
protected void	disableBehaviours(Set<Behaviour> boundBehaviours)
void	enable()	Enable Events2 generated events
protected void	enableBehaviours(Set<Behaviour> boundBehaviours)
protected NodeEventConsolidator	getEventConsolidator(NodeRef nodeRef)
protected EventInfo	getEventInfo(String user)
EventSender	getEventSender()
protected EventGenerator.Consolidators	getTxnConsolidators(Object resourceKey)
boolean	isEnabled()
void	onAddAspect(NodeRef nodeRef, QName aspectTypeQName)	Called after an aspect has been added to a node
protected void	onBootstrap(org.springframework.context.ApplicationEvent applicationEvent)
void	onCreateAssociation(AssociationRef associationRef)	Called after a regular node association is created.
void	onCreateChildAssociation(ChildAssociationRef childAssociationRef, boolean isNewNode)	Called after a node child association has been created.
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.
protected void	onShutdown(org.springframework.context.ApplicationEvent applicationEvent)
void	onUpdateProperties(NodeRef nodeRef, Map<QName,Serializable> before, Map<QName,Serializable> after)	Called after a node's properties have been changed.
void	setDescriptorService(DescriptorService descriptorService)
void	setDictionaryService(DictionaryService dictionaryService)
void	setEnabled(boolean enabled)
void	setEventFilterRegistry(EventFilterRegistry eventFilterRegistry)
void	setEventSender(EventSender eventSender)
void	setNamespaceService(NamespaceService namespaceService)
void	setNodeDAO(NodeDAO nodeDAO)
void	setNodeResourceHelper(NodeResourceHelper nodeResourceHelper)
void	setNodeService(NodeService nodeService)
void	setPersonService(PersonService personService)
void	setPolicyComponent(PolicyComponent policyComponent)
void	setTransactionService(TransactionService transactionService)

Methods inherited from class org.springframework.extensions.surf.util.AbstractLifecycleBean

getApplicationContext, onApplicationEvent, setApplicationContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.context.ApplicationListener

supportsAsyncExecution

Field Details

policyComponent

protected PolicyComponent policyComponent

nodeService

protected NodeService nodeService

dictionaryService

protected DictionaryService dictionaryService

nodeResourceHelper

protected NodeResourceHelper nodeResourceHelper

nodeDAO

protected NodeDAO nodeDAO

transactionListener

protected final EventGenerator.EventTransactionListener transactionListener

enabled

protected boolean enabled

Constructor Details

EventGenerator

public EventGenerator()

Method Details

setEnabled

public void setEnabled(boolean enabled)

isEnabled

public boolean isEnabled()

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

disable

public void disable()

Disable Events2 generated events

enable

public void enable()

Enable Events2 generated events

setNodeDAO

public void setNodeDAO(NodeDAO nodeDAO)

setPolicyComponent

public void setPolicyComponent(PolicyComponent policyComponent)

setNodeService

public void setNodeService(NodeService nodeService)

setNamespaceService

public void setNamespaceService(NamespaceService namespaceService)

setDictionaryService

public void setDictionaryService(DictionaryService dictionaryService)

setDescriptorService

public void setDescriptorService(DescriptorService descriptorService)

setEventFilterRegistry

public void setEventFilterRegistry(EventFilterRegistry eventFilterRegistry)

setTransactionService

public void setTransactionService(TransactionService transactionService)

setPersonService

public void setPersonService(PersonService personService)

setNodeResourceHelper

public void setNodeResourceHelper(NodeResourceHelper nodeResourceHelper)

setEventSender

public void setEventSender(EventSender eventSender)

getEventSender

public EventSender getEventSender()

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

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

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.

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

onCreateChildAssociation

public void onCreateChildAssociation(ChildAssociationRef childAssociationRef,
 boolean isNewNode)

Description copied from interface: NodeServicePolicies.OnCreateChildAssociationPolicy

Called after a node child association has been created.

Specified by:

onCreateChildAssociation in interface NodeServicePolicies.OnCreateChildAssociationPolicy

Parameters:

childAssociationRef - the child association that has been created

isNewNode - true if the node is new or false if the node is being linked in

beforeDeleteChildAssociation

public void beforeDeleteChildAssociation(ChildAssociationRef childAssociationRef)

Description copied from interface: NodeServicePolicies.BeforeDeleteChildAssociationPolicy

Called before a node child association is deleted.

Specified by:

beforeDeleteChildAssociation in interface NodeServicePolicies.BeforeDeleteChildAssociationPolicy

Parameters:

childAssociationRef - the child association to be deleted

onCreateAssociation

public void onCreateAssociation(AssociationRef associationRef)

Description copied from interface: NodeServicePolicies.OnCreateAssociationPolicy

Called after a regular node association is created.

Specified by:

onCreateAssociation in interface NodeServicePolicies.OnCreateAssociationPolicy

Parameters:

associationRef - the regular node association that was created

beforeDeleteAssociation

public void beforeDeleteAssociation(AssociationRef associationRef)

Description copied from interface: NodeServicePolicies.BeforeDeleteAssociationPolicy

Called before a regular node association is deleted.

Specified by:

beforeDeleteAssociation in interface NodeServicePolicies.BeforeDeleteAssociationPolicy

Parameters:

associationRef - the regular node association that will be removed

createEventConsolidator

protected NodeEventConsolidator createEventConsolidator()

createChildAssociationEventConsolidator

protected ChildAssociationEventConsolidator createChildAssociationEventConsolidator(ChildAssociationRef childAssociationRef)

createPeerAssociationEventConsolidator

protected PeerAssociationEventConsolidator createPeerAssociationEventConsolidator(AssociationRef peerAssociationRef)

bindClassBehaviour

protected Behaviour bindClassBehaviour(QName policyQName,
 String method)

bindAssociationBehaviour

protected Behaviour bindAssociationBehaviour(QName policyQName,
 String method)

disableBehaviours

protected void disableBehaviours(Set<Behaviour> boundBehaviours)

enableBehaviours

protected void enableBehaviours(Set<Behaviour> boundBehaviours)

getEventConsolidator

protected NodeEventConsolidator getEventConsolidator(NodeRef nodeRef)

Returns:

the NodeEventConsolidator for the supplied nodeRef from the current transaction context.

getTxnConsolidators

protected EventGenerator.Consolidators getTxnConsolidators(Object resourceKey)

getEventInfo

protected EventInfo getEventInfo(String user)

onBootstrap

protected void onBootstrap(org.springframework.context.ApplicationEvent applicationEvent)

Specified by:

onBootstrap in class org.springframework.extensions.surf.util.AbstractLifecycleBean

onShutdown

protected void onShutdown(org.springframework.context.ApplicationEvent applicationEvent)

Specified by:

onShutdown in class org.springframework.extensions.surf.util.AbstractLifecycleBean