org.alfresco.repo.events

Class EventGenerationBehaviours

java.lang.Object

org.alfresco.repo.events.AbstractEventGenerationBehaviours

org.alfresco.repo.events.EventGenerationBehaviours

All Implemented Interfaces:

CheckOutCheckInServicePolicies.BeforeCheckOut, CheckOutCheckInServicePolicies.OnCancelCheckOut, CheckOutCheckInServicePolicies.OnCheckIn, CheckOutCheckInServicePolicies.OnCheckOut, ContentServicePolicies.OnContentPropertyUpdatePolicy, ContentServicePolicies.OnContentReadPolicy, NodeServicePolicies.BeforeDeleteNodePolicy, NodeServicePolicies.OnAddAspectPolicy, NodeServicePolicies.OnCreateChildAssociationPolicy, NodeServicePolicies.OnCreateNodePolicy, NodeServicePolicies.OnDeleteChildAssociationPolicy, NodeServicePolicies.OnMoveNodePolicy, NodeServicePolicies.OnUpdatePropertiesPolicy, AssociationPolicy, ClassPolicy, Policy

public class EventGenerationBehaviours
extends AbstractEventGenerationBehaviours
implements ContentServicePolicies.OnContentPropertyUpdatePolicy, ContentServicePolicies.OnContentReadPolicy, NodeServicePolicies.OnCreateNodePolicy, NodeServicePolicies.BeforeDeleteNodePolicy, NodeServicePolicies.OnAddAspectPolicy, NodeServicePolicies.OnUpdatePropertiesPolicy, NodeServicePolicies.OnMoveNodePolicy, CheckOutCheckInServicePolicies.BeforeCheckOut, CheckOutCheckInServicePolicies.OnCheckOut, CheckOutCheckInServicePolicies.OnCheckIn, CheckOutCheckInServicePolicies.OnCancelCheckOut, NodeServicePolicies.OnDeleteChildAssociationPolicy, NodeServicePolicies.OnCreateChildAssociationPolicy

Author:

steveglover

Nested Class Summary

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

Policy.Arg

Field Summary

Fields

Modifier and Type	Field and Description
protected org.alfresco.service.cmr.dictionary.DictionaryService	dictionaryService
protected EventsService	eventsService
protected org.alfresco.service.namespace.NamespaceService	namespaceService
protected org.alfresco.service.cmr.repository.NodeService	nodeService

Fields inherited from class org.alfresco.repo.events.AbstractEventGenerationBehaviours

behaviours, includeEventTypes, logger, policyComponent

Fields inherited from interface org.alfresco.repo.content.ContentServicePolicies.OnContentPropertyUpdatePolicy

QNAME

Fields inherited from interface org.alfresco.repo.content.ContentServicePolicies.OnContentReadPolicy

QNAME

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

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

ARG_0, ARG_1, ARG_2, QNAME

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

QNAME

Fields inherited from interface org.alfresco.repo.coci.CheckOutCheckInServicePolicies.BeforeCheckOut

QNAME

Fields inherited from interface org.alfresco.repo.coci.CheckOutCheckInServicePolicies.OnCheckOut

QNAME

Fields inherited from interface org.alfresco.repo.coci.CheckOutCheckInServicePolicies.OnCheckIn

QNAME

Fields inherited from interface org.alfresco.repo.coci.CheckOutCheckInServicePolicies.OnCancelCheckOut

QNAME

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

QNAME

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

QNAME

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

NAMESPACE

Constructor Summary

Constructors

Constructor and Description
EventGenerationBehaviours()

Method Summary

Modifier and Type	Method and Description
void	beforeCheckOut(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.cmr.repository.NodeRef destinationParentNodeRef, org.alfresco.service.namespace.QName destinationAssocTypeQName, org.alfresco.service.namespace.QName destinationAssocQName)
void	beforeDeleteNode(org.alfresco.service.cmr.repository.NodeRef nodeRef) Called before a node is deleted.
void	beforeLock(org.alfresco.service.cmr.repository.NodeRef nodeRef, LockType lockType) Called before an attempt to lock the given node is made.
void	beforeRecordRejection(org.alfresco.service.cmr.repository.NodeRef nodeRef) Called before a record is rejected
void	beforeUnlock(org.alfresco.service.cmr.repository.NodeRef nodeRef) Called before an attempt to unlock the given node is made.
void	init()
void	onAddAspect(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName aspectTypeQName) Called after an aspect has been added to a node
void	onAuthorityAddedToGroup(String parentGroup, String childAuthority)
void	onAuthorityRemovedFromGroup(String parentGroup, String childAuthority)
void	onCancelCheckOut(org.alfresco.service.cmr.repository.NodeRef nodeRef)
void	onCheckIn(org.alfresco.service.cmr.repository.NodeRef nodeRef)
void	onCheckOut(org.alfresco.service.cmr.repository.NodeRef workingCopy)
void	onContentPropertyUpdate(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName propertyQName, org.alfresco.service.cmr.repository.ContentData beforeValue, org.alfresco.service.cmr.repository.ContentData afterValue)
void	onContentRead(org.alfresco.service.cmr.repository.NodeRef nodeRef)
void	onCreateChildAssociation(org.alfresco.service.cmr.repository.ChildAssociationRef newChildAssocRef, boolean isNewNode) Called after a node child association has been created.
void	onCreateNode(org.alfresco.service.cmr.repository.ChildAssociationRef childAssocRef) Called when a new node has been created.
void	onDeleteChildAssociation(org.alfresco.service.cmr.repository.ChildAssociationRef childAssocRef) Called after a node child association has been deleted.
void	onGrantLocalPermission(org.alfresco.service.cmr.repository.NodeRef nodeRef, String authority, String permission)
void	onGroupDeleted(String groupName, boolean cascade)
void	onInheritPermissionsDisabled(org.alfresco.service.cmr.repository.NodeRef nodeRef, boolean async)
void	onInheritPermissionsEnabled(org.alfresco.service.cmr.repository.NodeRef nodeRef)
void	onMoveNode(org.alfresco.service.cmr.repository.ChildAssociationRef oldChildAssocRef, org.alfresco.service.cmr.repository.ChildAssociationRef newChildAssocRef) Called when a node has been moved.
void	onRecordDeclaration(org.alfresco.service.cmr.repository.NodeRef nodeRef) Called after a file has been declared as a record
void	onRevokeLocalPermission(org.alfresco.service.cmr.repository.NodeRef nodeRef, String authority, String permission)
void	onUpdateContentSecurityMarks(org.alfresco.service.cmr.repository.NodeRef nodeRef, boolean wasMarkedBefore, boolean isMarkedAfter) Called after a new content node's security marking has been updated.
void	onUpdateProperties(org.alfresco.service.cmr.repository.NodeRef nodeRef, Map<org.alfresco.service.namespace.QName,Serializable> before, Map<org.alfresco.service.namespace.QName,Serializable> after) Called after a node's properties have been changed.
void	setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
void	setEventsService(EventsService eventsService)
void	setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)
void	setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)

Methods inherited from class org.alfresco.repo.events.AbstractEventGenerationBehaviours

addBehaviour, bindAssociationPolicy, bindClassPolicy, bindClassPolicy, bindClassPolicy, cleanUp, includeEventType, removeBehaviour, removeBehaviourImpl, setIncludeEventTypes, setPolicyComponent

Methods inherited from class java.lang.Object

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

Field Detail

eventsService

protected EventsService eventsService

dictionaryService

protected org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService

namespaceService

protected org.alfresco.service.namespace.NamespaceService namespaceService

nodeService

protected org.alfresco.service.cmr.repository.NodeService nodeService

Constructor Detail

EventGenerationBehaviours

public EventGenerationBehaviours()

Method Detail

setDictionaryService

public void setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)

setNamespaceService

public void setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)

setEventsService

public void setEventsService(EventsService eventsService)

setNodeService

public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)

init

public void init()

onContentRead

public void onContentRead(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Specified by:

onContentRead in interface ContentServicePolicies.OnContentReadPolicy

Parameters:

nodeRef - the node reference

onCreateNode

public void onCreateNode(org.alfresco.service.cmr.repository.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

onUpdateProperties

public void onUpdateProperties(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                               Map<org.alfresco.service.namespace.QName,Serializable> before,
                               Map<org.alfresco.service.namespace.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

onAddAspect

public void onAddAspect(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                        org.alfresco.service.namespace.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

onMoveNode

public void onMoveNode(org.alfresco.service.cmr.repository.ChildAssociationRef oldChildAssocRef,
                       org.alfresco.service.cmr.repository.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

beforeDeleteNode

public void beforeDeleteNode(org.alfresco.service.cmr.repository.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

onContentPropertyUpdate

public void onContentPropertyUpdate(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                    org.alfresco.service.namespace.QName propertyQName,
                                    org.alfresco.service.cmr.repository.ContentData beforeValue,
                                    org.alfresco.service.cmr.repository.ContentData afterValue)

Specified by:

onContentPropertyUpdate in interface ContentServicePolicies.OnContentPropertyUpdatePolicy

Parameters:

nodeRef - the node reference

propertyQName - the name of the property that changed

beforeValue - the value of the content data prior to the change. Note that this value may be null or any of it's member values may be null according to the contract of the ContentData class.

afterValue - the value of the content data after the change

See Also:

ContentData.hasContent(ContentData), ContentServiceImpl.onUpdateProperties(NodeRef, java.util.Map, java.util.Map)

onCheckOut

public void onCheckOut(org.alfresco.service.cmr.repository.NodeRef workingCopy)

Specified by:

onCheckOut in interface CheckOutCheckInServicePolicies.OnCheckOut

Parameters:

workingCopy - - working copy

onCancelCheckOut

public void onCancelCheckOut(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Specified by:

onCancelCheckOut in interface CheckOutCheckInServicePolicies.OnCancelCheckOut

Parameters:

nodeRef - NodeRef

onCheckIn

public void onCheckIn(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Specified by:

onCheckIn in interface CheckOutCheckInServicePolicies.OnCheckIn

Parameters:

nodeRef - NodeRef

beforeCheckOut

public void beforeCheckOut(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                           org.alfresco.service.cmr.repository.NodeRef destinationParentNodeRef,
                           org.alfresco.service.namespace.QName destinationAssocTypeQName,
                           org.alfresco.service.namespace.QName destinationAssocQName)

Specified by:

beforeCheckOut in interface CheckOutCheckInServicePolicies.BeforeCheckOut

Parameters:

nodeRef - NodeRef

destinationParentNodeRef - NodeRef

destinationAssocTypeQName - QName

destinationAssocQName - QName

onAuthorityRemovedFromGroup

public void onAuthorityRemovedFromGroup(String parentGroup,
                                        String childAuthority)

onAuthorityAddedToGroup

public void onAuthorityAddedToGroup(String parentGroup,
                                    String childAuthority)

onInheritPermissionsEnabled

public void onInheritPermissionsEnabled(org.alfresco.service.cmr.repository.NodeRef nodeRef)

onInheritPermissionsDisabled

public void onInheritPermissionsDisabled(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                         boolean async)

onRevokeLocalPermission

public void onRevokeLocalPermission(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                    String authority,
                                    String permission)

onGrantLocalPermission

public void onGrantLocalPermission(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                   String authority,
                                   String permission)

onGroupDeleted

public void onGroupDeleted(String groupName,
                           boolean cascade)

onCreateChildAssociation

public void onCreateChildAssociation(org.alfresco.service.cmr.repository.ChildAssociationRef newChildAssocRef,
                                     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:

newChildAssocRef - the child association that has been created

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

onDeleteChildAssociation

public void onDeleteChildAssociation(org.alfresco.service.cmr.repository.ChildAssociationRef childAssocRef)

Description copied from interface: NodeServicePolicies.OnDeleteChildAssociationPolicy

Called after a node child association has been deleted.

Specified by:

onDeleteChildAssociation in interface NodeServicePolicies.OnDeleteChildAssociationPolicy

Parameters:

childAssocRef - the child association that has been deleted

onUpdateContentSecurityMarks

public void onUpdateContentSecurityMarks(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                         boolean wasMarkedBefore,
                                         boolean isMarkedAfter)

Called after a new content node's security marking has been updated.

Parameters:

nodeRef - reference to the updated node

wasMarkedBefore - - indicated if before update the content was marked

isMarkedAfter - - indicated if after update the content is marked

onRecordDeclaration

public void onRecordDeclaration(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Called after a file has been declared as a record

Parameters:

nodeRef - the file being declared as a record

beforeRecordRejection

public void beforeRecordRejection(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Called before a record is rejected

Parameters:

nodeRef - the record about to be rejected

beforeLock

public void beforeLock(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                       LockType lockType)

Called before an attempt to lock the given node is made.

Parameters:

nodeRef - NodeRef

lockType - LockType

beforeUnlock

public void beforeUnlock(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Called before an attempt to unlock the given node is made.

Parameters:

nodeRef - NodeRef