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 Details

    • getQuotaStatsUpdaters

      List<QuotaStatsUpdater> getQuotaStatsUpdaters()
    • updateStatistics

      void updateStatistics(DocumentEventContext docCtx, Event event)
      Update the statistics for the given docCtx and event.

      Call all the registered QuotaStatsUpdaters.

    • computeInitialStatistics

      @Deprecated default void computeInitialStatistics(String updaterName, CoreSession session, QuotaStatsInitialWork currentWorker)
      Deprecated.
      since 10.1, use other signature
      Compute the initial statistics for the given @{code updaterName}.
    • computeInitialStatistics

      void computeInitialStatistics(String updaterName, CoreSession session, QuotaStatsInitialWork currentWorker, String path)
      Compute the initial statistics for the given @{code updaterName} for docPath.
      Since:
      10.1
    • launchInitialStatisticsComputation

      @Deprecated default void launchInitialStatisticsComputation(String updaterName, String repositoryName)
      Deprecated.
      since 10.1, use other signature
      Launch an asynchronously initial computation for the given updaterName on repositoryName.
    • launchInitialStatisticsComputation

      void launchInitialStatisticsComputation(String updaterName, String repositoryName, String path)
      Launch an asynchronously initial computation for the given updaterName on repositoryName for docPath.
      Since:
      10.1
    • getProgressStatus

      String getProgressStatus(String updaterName, String repositoryName)
      Returns the progress status of updaterName.
    • getQuotaFromParent

      long getQuotaFromParent(DocumentModel doc, CoreSession session)
      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
      Since:
      5.7
    • canSetMaxQuota

      boolean canSetMaxQuota(long maxQuota, DocumentModel doc, CoreSession session)
      Test to see if quota allowed. Skip user worskpaces, where validation rules don't apply.
      Since:
      5.7
    • launchSetMaxQuotaOnUserWorkspaces

      void launchSetMaxQuotaOnUserWorkspaces(long maxQuota, DocumentModel context, CoreSession session)
      Sets this maxQuota on all user workspaces
      Since:
      5.7
    • activateQuotaOnUserWorkspaces

      void activateQuotaOnUserWorkspaces(long maxQuota, CoreSession session)
      Activates the quota on user personal workspaces
      Since:
      5.7
    • getQuotaSetOnUserWorkspaces

      long getQuotaSetOnUserWorkspaces(CoreSession session)
      Since:
      5.7