Package org.nuxeo.ecm.quota

Interface QuotaStatsUpdater

All Known Implementing Classes:

AbstractQuotaStatsUpdater, DocumentsCountUpdater, DocumentsSizeUpdater

public interface QuotaStatsUpdater

Interface to be implemented by QuotaStatsUpdaters registered to the QuotaStatsService.

They use an unrestricted CoreSession to do the update.

Since:

5.5

Author:

Thomas Roger

Method Summary

Modifier and Type	Method	Description
default void	computeInitialStatistics(CoreSession session, QuotaStatsInitialWork currentWorker)	Deprecated. since 10.1, use other signature
void	computeInitialStatistics(CoreSession session, QuotaStatsInitialWork currentWorker, String path)	Compute the initial statistics under the given path for this QuotaStatsUpdater.
String	getDescriptionLabel()
String	getLabel()
String	getName()
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.

Method Detail

updateStatistics

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

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

Parameters:

session - an unrestricted CoreSession to be used

computeInitialStatistics

@Deprecated
default void computeInitialStatistics(CoreSession session,
                                      QuotaStatsInitialWork currentWorker)

Deprecated.

since 10.1, use other signature

Compute the initial statistics on the whole repository for this QuotaStatsUpdater.

Parameters:

session - an unrestricted CoreSession to be used

computeInitialStatistics

void computeInitialStatistics(CoreSession session,
                              QuotaStatsInitialWork currentWorker,
                              String path)

Compute the initial statistics under the given path for this QuotaStatsUpdater.

Parameters:

session - an unrestricted CoreSession to be used

path - the root of the recomputation, or null for the whole repository

Since:

10.1

setName

void setName(String name)

getName

String getName()

setLabel

void setLabel(String label)

getLabel

String getLabel()

setDescriptionLabel

void setDescriptionLabel(String descriptionLabel)

getDescriptionLabel

String getDescriptionLabel()