org.nuxeo.ecm.quota

Interface QuotaStatsService

All Known Implementing Classes:

QuotaStatsServiceImpl

public interface QuotaStatsService

Service used to compute quota and statistics on documents.

Since:

5.5

Author:

Thomas Roger

Method Summary

Methods

Modifier and Type	Method and Description
void	activateQuotaOnUserWorkspaces(long maxQuota, CoreSession session) Activates the quota on user personal workspaces
boolean	canSetMaxQuota(long maxQuota, DocumentModel doc, CoreSession session) Test to see if quota allowed.
void	computeInitialStatistics(String updaterName, CoreSession session, QuotaStatsInitialWork currentWorker) Compute the initial statistics for the given @{code updaterName}.
String	getProgressStatus(String updaterName, String repositoryName) Returns the progress status of updaterName.
long	getQuotaFromParent(DocumentModel doc, CoreSession session) Gets the quota from the first parent where quota has been set.
long	getQuotaSetOnUserWorkspaces(CoreSession session)
List<QuotaStatsUpdater>	getQuotaStatsUpdaters()
void	launchInitialStatisticsComputation(String updaterName, String repositoryName) Launch an asynchronously initial computation for the given updaterName on repositoryName.
void	launchSetMaxQuotaOnUserWorkspaces(long maxQuota, DocumentModel context, CoreSession session) Sets this maxQuota on all user workspaces
void	updateStatistics(DocumentEventContext docCtx, Event event) Update the statistics for the given docCtx and event.

Method Detail

getQuotaStatsUpdaters

List<QuotaStatsUpdater> getQuotaStatsUpdaters()

updateStatistics

void updateStatistics(DocumentEventContext docCtx,
                    Event event)
                      throws ClientException

Update the statistics for the given docCtx and event.

Call all the registered QuotaStatsUpdaters.

Throws:

ClientException

computeInitialStatistics

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

Compute the initial statistics for the given @{code updaterName}.

launchInitialStatisticsComputation

void launchInitialStatisticsComputation(String updaterName,
                                      String repositoryName)

Launch an asynchronously initial computation for the given updaterName on repositoryName.

getProgressStatus

String getProgressStatus(String updaterName,
                       String repositoryName)

Returns the progress status of updaterName.

getQuotaFromParent

long getQuotaFromParent(DocumentModel doc,
                      CoreSession session)
                        throws ClientException

Gets the quota from the first parent where quota has been set. Returns -1 if no quota has been set. For user workspaces, only the first parent is investigated

Throws:

ClientException

Since:

5.7

canSetMaxQuota

boolean canSetMaxQuota(long maxQuota,
                     DocumentModel doc,
                     CoreSession session)
                       throws ClientException

Test to see if quota allowed. Skip user worskpaces, where validation rules don't apply.

Throws:

ClientException

Since:

5.7

launchSetMaxQuotaOnUserWorkspaces

void launchSetMaxQuotaOnUserWorkspaces(long maxQuota,
                                     DocumentModel context,
                                     CoreSession session)
                                       throws ClientException

Sets this maxQuota on all user workspaces

Throws:

ClientException

Since:

5.7

activateQuotaOnUserWorkspaces

void activateQuotaOnUserWorkspaces(long maxQuota,
                                 CoreSession session)
                                   throws ClientException

Activates the quota on user personal workspaces

Throws:

ClientException

Since:

5.7

getQuotaSetOnUserWorkspaces

long getQuotaSetOnUserWorkspaces(CoreSession session)
                                 throws ClientException

Throws:

ClientException

Since:

5.7