org.alfresco.repo.events

Class AbstractEventsService

java.lang.Object

org.alfresco.repo.transaction.TransactionListenerAdapter

org.alfresco.repo.events.AbstractEventsService

All Implemented Interfaces:

org.alfresco.util.transaction.TransactionListener

Direct Known Subclasses:

EventsServiceImpl, ExceptionEventsServiceImpl

public abstract class AbstractEventsService
extends org.alfresco.repo.transaction.TransactionListenerAdapter

Author:

steveglover

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractEventsService.NodeInfo

Field Summary

Fields

Modifier and Type	Field and Description
protected org.alfresco.service.cmr.coci.CheckOutCheckInService	cociService
protected org.alfresco.service.cmr.dictionary.DictionaryService	dictionaryService
protected org.alfresco.events.EventRegistry	eventRegistry
protected org.alfresco.service.cmr.model.FileFolderService	fileFolderService
protected org.alfresco.repo.model.filefolder.HiddenAspect	hiddenAspect
protected Set<String>	includeEventTypes
protected Set<org.alfresco.service.namespace.QName>	matchingTypes
protected org.alfresco.service.namespace.NamespaceService	namespaceService
protected org.alfresco.service.cmr.repository.NodeService	nodeService
protected org.alfresco.service.cmr.security.PermissionService	permissionService
protected boolean	sendEventsBeforeCommit
protected org.alfresco.service.cmr.site.SiteService	siteService
protected static String	TRANSACTION_HAS_EVENTS
protected org.alfresco.service.transaction.TransactionService	transactionService

Constructor Summary

Constructors

Constructor and Description
AbstractEventsService()

Method Summary

Modifier and Type	Method and Description
void	afterCommit()
void	afterRollback()
void	beforeCommit(boolean readOnly)
protected List<org.alfresco.events.types.Event>	filterEventsBeforeSend(List<org.alfresco.events.types.Event> events) Filter out event before sending them to MessageProducer
protected org.alfresco.repo.Client	getAlfrescoClient(org.alfresco.repo.Client knownClientType)
protected List<List<String>>	getNodeIds(List<org.alfresco.service.cmr.repository.Path> nodePaths) For each path, construct a list of ancestor node ids starting with the leaf path element node id first.
protected List<List<String>>	getNodeIdsFromParent(List<org.alfresco.service.cmr.repository.Path> nodePaths) For each path, construct a list of ancestor node ids starting with the parent node id first.
protected AbstractEventsService.NodeInfo	getNodeInfo(org.alfresco.service.cmr.repository.NodeRef nodeRef, String eventType)
protected List<String>	getPaths(List<org.alfresco.service.cmr.repository.Path> nodePaths, List<String> toAppend)
protected org.alfresco.repo.events.AbstractEventsService.TxnEvents	getTxnEvents()
protected boolean	includeEventType(String eventType)
void	init()
protected long	nextSequenceNumber()
protected void	retrieveAdditionalProps(Map<String,Serializable> properties, org.alfresco.service.cmr.repository.NodeRef nodeRef) Extract additional information for the provided node
void	sendEvent(org.alfresco.events.types.Event event) Register the event to be sent to a message producer once the transaction is over
void	setCociService(org.alfresco.service.cmr.coci.CheckOutCheckInService cociService)
void	setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
void	setEventRegistry(org.alfresco.events.EventRegistry eventRegistry)
void	setFileFolderService(org.alfresco.service.cmr.model.FileFolderService fileFolderService)
void	setHiddenAspect(org.alfresco.repo.model.filefolder.HiddenAspect hiddenAspect)
void	setIncludeEventTypes(String includeEventTypesStr)
void	setMessageProducer(org.gytheio.messaging.MessageProducer messageProducer)
void	setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)
void	setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
void	setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService)
void	setSendEventsBeforeCommit(boolean sendEventsBeforeCommit)
void	setSiteService(org.alfresco.service.cmr.site.SiteService siteService)
void	setTransactionService(org.alfresco.service.transaction.TransactionService transactionService)
protected boolean	shouldSendCommitEvent() Determines whether it still makes sense to create and send a TransactionCommittedEvent after the transaction is committed.

Methods inherited from class org.alfresco.repo.transaction.TransactionListenerAdapter

beforeCompletion, flush

Methods inherited from class java.lang.Object

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

Field Detail

TRANSACTION_HAS_EVENTS

protected static final String TRANSACTION_HAS_EVENTS

See Also:

Constant Field Values

cociService

protected org.alfresco.service.cmr.coci.CheckOutCheckInService cociService

siteService

protected org.alfresco.service.cmr.site.SiteService siteService

nodeService

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

dictionaryService

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

namespaceService

protected org.alfresco.service.namespace.NamespaceService namespaceService

permissionService

protected org.alfresco.service.cmr.security.PermissionService permissionService

hiddenAspect

protected org.alfresco.repo.model.filefolder.HiddenAspect hiddenAspect

eventRegistry

protected org.alfresco.events.EventRegistry eventRegistry

fileFolderService

protected org.alfresco.service.cmr.model.FileFolderService fileFolderService

transactionService

protected org.alfresco.service.transaction.TransactionService transactionService

includeEventTypes

protected Set<String> includeEventTypes

matchingTypes

protected Set<org.alfresco.service.namespace.QName> matchingTypes

sendEventsBeforeCommit

protected boolean sendEventsBeforeCommit

Constructor Detail

AbstractEventsService

public AbstractEventsService()

Method Detail

setCociService

public void setCociService(org.alfresco.service.cmr.coci.CheckOutCheckInService cociService)

setHiddenAspect

public void setHiddenAspect(org.alfresco.repo.model.filefolder.HiddenAspect hiddenAspect)

setSendEventsBeforeCommit

public void setSendEventsBeforeCommit(boolean sendEventsBeforeCommit)

setTransactionService

public void setTransactionService(org.alfresco.service.transaction.TransactionService transactionService)

setIncludeEventTypes

public void setIncludeEventTypes(String includeEventTypesStr)

setFileFolderService

public void setFileFolderService(org.alfresco.service.cmr.model.FileFolderService fileFolderService)

setEventRegistry

public void setEventRegistry(org.alfresco.events.EventRegistry eventRegistry)

setNamespaceService

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

setPermissionService

public void setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService)

setMessageProducer

public void setMessageProducer(org.gytheio.messaging.MessageProducer messageProducer)

setDictionaryService

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

setNodeService

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

setSiteService

public void setSiteService(org.alfresco.service.cmr.site.SiteService siteService)

init

public void init()

nextSequenceNumber

protected long nextSequenceNumber()

beforeCommit

public void beforeCommit(boolean readOnly)

Specified by:

beforeCommit in interface org.alfresco.util.transaction.TransactionListener

Overrides:

beforeCommit in class org.alfresco.repo.transaction.TransactionListenerAdapter

getAlfrescoClient

protected org.alfresco.repo.Client getAlfrescoClient(org.alfresco.repo.Client knownClientType)

afterCommit

public void afterCommit()

Specified by:

afterCommit in interface org.alfresco.util.transaction.TransactionListener

Overrides:

afterCommit in class org.alfresco.repo.transaction.TransactionListenerAdapter

shouldSendCommitEvent

protected boolean shouldSendCommitEvent()

Determines whether it still makes sense to create and send a TransactionCommittedEvent after the transaction is committed. (e.g. if there are no events for the specific transaction makes no sense to signal the end of transaction with TransactionCommittedEvent)

Returns:

whether the TransactionCommitted event should be sent

filterEventsBeforeSend

protected List<org.alfresco.events.types.Event> filterEventsBeforeSend(List<org.alfresco.events.types.Event> events)

Filter out event before sending them to MessageProducer

Parameters:

events - the events to be filtered

Returns:

a filtered list of events

afterRollback

public void afterRollback()

Specified by:

afterRollback in interface org.alfresco.util.transaction.TransactionListener

Overrides:

afterRollback in class org.alfresco.repo.transaction.TransactionListenerAdapter

includeEventType

protected boolean includeEventType(String eventType)

retrieveAdditionalProps

protected void retrieveAdditionalProps(Map<String,Serializable> properties,
                                       org.alfresco.service.cmr.repository.NodeRef nodeRef)

Extract additional information for the provided node

Parameters:

properties - the properties map to add the new info to

nodeRef - the node to extract the property from

getPaths

protected List<String> getPaths(List<org.alfresco.service.cmr.repository.Path> nodePaths,
                                List<String> toAppend)

getNodeIdsFromParent

protected List<List<String>> getNodeIdsFromParent(List<org.alfresco.service.cmr.repository.Path> nodePaths)

For each path, construct a list of ancestor node ids starting with the parent node id first.

Parameters:

nodePaths -

Returns:

getNodeIds

protected List<List<String>> getNodeIds(List<org.alfresco.service.cmr.repository.Path> nodePaths)

For each path, construct a list of ancestor node ids starting with the leaf path element node id first.

Parameters:

nodePaths -

Returns:

getTxnEvents

protected org.alfresco.repo.events.AbstractEventsService.TxnEvents getTxnEvents()

sendEvent

public void sendEvent(org.alfresco.events.types.Event event)

Register the event to be sent to a message producer once the transaction is over

Parameters:

event - event to be sent

getNodeInfo

protected AbstractEventsService.NodeInfo getNodeInfo(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                                     String eventType)