Package org.nuxeo.ecm.quota

Class AbstractQuotaStatsUpdater

java.lang.Object

org.nuxeo.ecm.quota.AbstractQuotaStatsUpdater

All Implemented Interfaces:

QuotaStatsUpdater

Direct Known Subclasses:

DocumentsCountUpdater, DocumentsSizeUpdater

public abstract class AbstractQuotaStatsUpdater
extends Object
implements QuotaStatsUpdater

Abstract class implementing QuotaStatsUpdater to handle common cases.

Provides abstract methods to override for common events.

Since:

5.5

Author:

Thomas Roger

Field Summary

Fields

Modifier and Type	Field	Description
protected String	descriptionLabel
protected String	label
protected static Log	log
protected String	name

Constructor Summary

Constructors

Constructor	Description
AbstractQuotaStatsUpdater()

Method Summary

Modifier and Type	Method	Description
protected List<DocumentModel>	getAncestors(CoreSession session, DocumentModel doc)	Gets all the ancestors of the document, including the root.
String	getDescriptionLabel()
String	getLabel()
String	getName()
protected abstract void	handleQuotaExceeded(QuotaExceededException e, Event event)
protected abstract boolean	needToProcessEventOnDocument(Event event, DocumentModel doc)
protected abstract void	processDocumentAboutToBeRemoved(CoreSession session, DocumentModel doc)
protected abstract void	processDocumentBeforeCheckedIn(CoreSession session, DocumentModel doc)
protected abstract void	processDocumentBeforeCheckedOut(CoreSession session, DocumentModel doc)
protected abstract void	processDocumentBeforeRestore(CoreSession session, DocumentModel doc)
protected abstract void	processDocumentBeforeUpdate(CoreSession session, DocumentModel doc)
protected abstract void	processDocumentCheckedIn(CoreSession session, DocumentModel doc)
protected abstract void	processDocumentCheckedOut(CoreSession session, DocumentModel doc)
protected abstract void	processDocumentCopied(CoreSession session, DocumentModel doc)
protected abstract void	processDocumentCreated(CoreSession session, DocumentModel doc)
protected abstract void	processDocumentMoved(CoreSession session, DocumentModel doc, DocumentModel sourceParent)
protected abstract void	processDocumentRestored(CoreSession session, DocumentModel doc)
protected abstract void	processDocumentTrashOp(CoreSession session, DocumentModel doc, boolean isTrashed)
protected abstract void	processDocumentUpdated(CoreSession session, DocumentModel doc)
void	setDescriptionLabel(String descriptionLabel)
void	setLabel(String label)
void	setName(String name)
void	updateStatistics(CoreSession session, DocumentEventContext docCtx, Event event)	Update the statistics for the given docCtx and event.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.ecm.quota.QuotaStatsUpdater

computeInitialStatistics, computeInitialStatistics

Field Detail

name

protected String name

label

protected String label

descriptionLabel

protected String descriptionLabel

log

protected static Log log

Constructor Detail

AbstractQuotaStatsUpdater

public AbstractQuotaStatsUpdater()

Method Detail

setName

public void setName(String name)

Specified by:

setName in interface QuotaStatsUpdater

getName

public String getName()

Specified by:

getName in interface QuotaStatsUpdater

setLabel

public void setLabel(String label)

Specified by:

setLabel in interface QuotaStatsUpdater

getLabel

public String getLabel()

Specified by:

getLabel in interface QuotaStatsUpdater

setDescriptionLabel

public void setDescriptionLabel(String descriptionLabel)

Specified by:

setDescriptionLabel in interface QuotaStatsUpdater

getDescriptionLabel

public String getDescriptionLabel()

Specified by:

getDescriptionLabel in interface QuotaStatsUpdater

updateStatistics

public void updateStatistics(CoreSession session,
                             DocumentEventContext docCtx,
                             Event event)

Description copied from interface: QuotaStatsUpdater

Update the statistics for the given docCtx and event. Signature was changed in 5.6 to pass the Event instead of the eventName to allow the implementer to rollback the transaction if needed

Specified by:

updateStatistics in interface QuotaStatsUpdater

Parameters:

session - an unrestricted CoreSession to be used

getAncestors

protected List<DocumentModel> getAncestors(CoreSession session,
                                           DocumentModel doc)

Gets all the ancestors of the document, including the root.

handleQuotaExceeded

protected abstract void handleQuotaExceeded(QuotaExceededException e,
                                            Event event)

needToProcessEventOnDocument

protected abstract boolean needToProcessEventOnDocument(Event event,
                                                        DocumentModel doc)

processDocumentCreated

protected abstract void processDocumentCreated(CoreSession session,
                                               DocumentModel doc)

processDocumentCopied

protected abstract void processDocumentCopied(CoreSession session,
                                              DocumentModel doc)

processDocumentCheckedIn

protected abstract void processDocumentCheckedIn(CoreSession session,
                                                 DocumentModel doc)

processDocumentBeforeCheckedIn

protected abstract void processDocumentBeforeCheckedIn(CoreSession session,
                                                       DocumentModel doc)

Since:

11.1

processDocumentCheckedOut

protected abstract void processDocumentCheckedOut(CoreSession session,
                                                  DocumentModel doc)

processDocumentBeforeCheckedOut

protected abstract void processDocumentBeforeCheckedOut(CoreSession session,
                                                        DocumentModel doc)

Since:

11.1

processDocumentUpdated

protected abstract void processDocumentUpdated(CoreSession session,
                                               DocumentModel doc)

processDocumentMoved

protected abstract void processDocumentMoved(CoreSession session,
                                             DocumentModel doc,
                                             DocumentModel sourceParent)

processDocumentAboutToBeRemoved

protected abstract void processDocumentAboutToBeRemoved(CoreSession session,
                                                        DocumentModel doc)

processDocumentBeforeUpdate

protected abstract void processDocumentBeforeUpdate(CoreSession session,
                                                    DocumentModel doc)

processDocumentTrashOp

protected abstract void processDocumentTrashOp(CoreSession session,
                                               DocumentModel doc,
                                               boolean isTrashed)

processDocumentRestored

protected abstract void processDocumentRestored(CoreSession session,
                                                DocumentModel doc)

processDocumentBeforeRestore

protected abstract void processDocumentBeforeRestore(CoreSession session,
                                                     DocumentModel doc)