Package org.alfresco.repo.events

Class AbstractEventsService

java.lang.Object

org.alfresco.repo.transaction.TransactionListenerAdapter

org.alfresco.repo.events.AbstractEventsService

All Implemented Interfaces:

TransactionListener, TransactionListener

Direct Known Subclasses:

EventsServiceImpl, ExceptionEventsServiceImpl

public abstract class AbstractEventsService
extends TransactionListenerAdapter

Author:

steveglover

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractEventsService.NodeInfo

Field Summary

Fields

Modifier and Type	Field	Description
protected CheckOutCheckInService	cociService
protected DictionaryService	dictionaryService
protected org.alfresco.sync.events.EventRegistry	eventRegistry
protected FileFolderService	fileFolderService
protected HiddenAspect	hiddenAspect
protected Set<String>	includeEventTypes
protected Set<QName>	matchingTypes
protected NamespaceService	namespaceService
protected NodeService	nodeService
protected PermissionService	permissionService
protected boolean	sendEventsBeforeCommit
protected SiteService	siteService
protected static String	TRANSACTION_HAS_EVENTS
protected TransactionService	transactionService

Constructor Summary

Constructors

Constructor	Description
AbstractEventsService()

Method Summary

Modifier and Type	Method	Description
void	afterCommit()	Invoked after transaction commit.
void	afterRollback()	Invoked after transaction rollback.
void	beforeCommit(boolean readOnly)	Called before a transaction is committed.
protected List<org.alfresco.sync.events.types.Event>	filterEventsBeforeSend(List<org.alfresco.sync.events.types.Event> events)	Filter out event before sending them to MessageProducer
protected org.alfresco.sync.repo.Client	getAlfrescoClient(org.alfresco.sync.repo.Client knownClientType)
protected List<List<String>>	getNodeIds(List<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<Path> nodePaths)	For each path, construct a list of ancestor node ids starting with the parent node id first.
protected AbstractEventsService.NodeInfo	getNodeInfo(NodeRef nodeRef, String eventType)
protected List<String>	getPaths(List<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, NodeRef nodeRef)	Extract additional information for the provided node
void	sendEvent(org.alfresco.sync.events.types.Event event)	Register the event to be sent to a message producer once the transaction is over
void	setCociService(CheckOutCheckInService cociService)
void	setDictionaryService(DictionaryService dictionaryService)
void	setEventRegistry(org.alfresco.sync.events.EventRegistry eventRegistry)
void	setFileFolderService(FileFolderService fileFolderService)
void	setHiddenAspect(HiddenAspect hiddenAspect)
void	setIncludeEventTypes(String includeEventTypesStr)
void	setMessageProducer(org.gytheio.messaging.MessageProducer messageProducer)
void	setNamespaceService(NamespaceService namespaceService)
void	setNodeService(NodeService nodeService)
void	setPermissionService(PermissionService permissionService)
void	setSendEventsBeforeCommit(boolean sendEventsBeforeCommit)
void	setSiteService(SiteService siteService)
void	setTransactionService(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 CheckOutCheckInService cociService

siteService

protected SiteService siteService

nodeService

protected NodeService nodeService

dictionaryService

protected DictionaryService dictionaryService

namespaceService

protected NamespaceService namespaceService

permissionService

protected PermissionService permissionService

hiddenAspect

protected HiddenAspect hiddenAspect

eventRegistry

protected org.alfresco.sync.events.EventRegistry eventRegistry

fileFolderService

protected FileFolderService fileFolderService

transactionService

protected TransactionService transactionService

includeEventTypes

protected Set<String> includeEventTypes

matchingTypes

protected Set<QName> matchingTypes

sendEventsBeforeCommit

protected boolean sendEventsBeforeCommit

Constructor Detail

AbstractEventsService

public AbstractEventsService()

Method Detail

setCociService

public void setCociService(CheckOutCheckInService cociService)

setHiddenAspect

public void setHiddenAspect(HiddenAspect hiddenAspect)

setSendEventsBeforeCommit

public void setSendEventsBeforeCommit(boolean sendEventsBeforeCommit)

setTransactionService

public void setTransactionService(TransactionService transactionService)

setIncludeEventTypes

public void setIncludeEventTypes(String includeEventTypesStr)

setFileFolderService

public void setFileFolderService(FileFolderService fileFolderService)

setEventRegistry

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

setNamespaceService

public void setNamespaceService(NamespaceService namespaceService)

setPermissionService

public void setPermissionService(PermissionService permissionService)

setMessageProducer

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

setDictionaryService

public void setDictionaryService(DictionaryService dictionaryService)

setNodeService

public void setNodeService(NodeService nodeService)

setSiteService

public void setSiteService(SiteService siteService)

init

public void init()

nextSequenceNumber

protected long nextSequenceNumber()

beforeCommit

public void beforeCommit(boolean readOnly)

Description copied from class: TransactionListenerAdapter

Called before a transaction is committed.

All transaction resources are still available.

Specified by:

beforeCommit in interface TransactionListener

Specified by:

beforeCommit in interface TransactionListener

Overrides:

beforeCommit in class TransactionListenerAdapter

Parameters:

readOnly - true if the transaction is read-only

getAlfrescoClient

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

afterCommit

public void afterCommit()

Description copied from class: TransactionListenerAdapter

Invoked after transaction commit.

Any exceptions generated here will only be logged and will have no effect on the state of the transaction.

Although all transaction resources are still available, this method should be used only for cleaning up resources after a commit has occured.

Specified by:

afterCommit in interface TransactionListener

Specified by:

afterCommit in interface TransactionListener

Overrides:

afterCommit in class 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.sync.events.types.Event> filterEventsBeforeSend(List<org.alfresco.sync.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()

Description copied from class: TransactionListenerAdapter

Invoked after transaction rollback.

Any exceptions generated here will only be logged and will have no effect on the state of the transaction.

Although all transaction resources are still available, this method should be used only for cleaning up resources after a rollback has occured.

Specified by:

afterRollback in interface TransactionListener

Specified by:

afterRollback in interface TransactionListener

Overrides:

afterRollback in class TransactionListenerAdapter

includeEventType

protected boolean includeEventType(String eventType)

retrieveAdditionalProps

protected void retrieveAdditionalProps(Map<String,Serializable> properties,
                                       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<Path> nodePaths,
                                List<String> toAppend)

getNodeIdsFromParent

protected List<List<String>> getNodeIdsFromParent(List<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<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.sync.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(NodeRef nodeRef,
                                                     String eventType)