org.nuxeo.ecm.quota

Class QuotaStatsServiceImpl

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.quota.QuotaStatsServiceImpl

All Implemented Interfaces:

QuotaStatsService, Adaptable, Component, Extensible, TimestampedService

public class QuotaStatsServiceImpl
extends DefaultComponent
implements QuotaStatsService

Default implementation of QuotaStatsService.

Since:

5.5

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_BATCH_SIZE
static String	QUOTA_STATS_UPDATERS_EP
static String	STATUS_INITIAL_COMPUTATION_COMPLETED
static String	STATUS_INITIAL_COMPUTATION_PENDING
static String	STATUS_INITIAL_COMPUTATION_QUEUED

Constructor Summary

Constructors

Constructor and Description
QuotaStatsServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	activate(ComponentContext context) Activates the component.
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()
QuotaStatsUpdater	getQuotaStatsUpdaters(String updaterName)
String	getUserWorkspaceRootId(DocumentModel context, CoreSession session)
void	launchInitialStatisticsComputation(String updaterName, String repositoryName) Launch an asynchronously initial computation for the given updaterName on repositoryName.
void	launchSetMaxQuotaOnUserWorkspaces(long maxSize, DocumentModel context, CoreSession session) Sets this maxQuota on all user workspaces
void	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
void	unregisterContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
void	updateStatistics(DocumentEventContext docCtx, Event event) Update the statistics for the given docCtx and event.

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

applicationStarted, deactivate, getAdapter, getApplicationStartedOrder, getLastModified, registerExtension, setLastModified, unregisterExtension

Methods inherited from class java.lang.Object

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

Field Detail

STATUS_INITIAL_COMPUTATION_QUEUED

public static final String STATUS_INITIAL_COMPUTATION_QUEUED

See Also:

Constant Field Values

STATUS_INITIAL_COMPUTATION_PENDING

public static final String STATUS_INITIAL_COMPUTATION_PENDING

See Also:

Constant Field Values

STATUS_INITIAL_COMPUTATION_COMPLETED

public static final String STATUS_INITIAL_COMPUTATION_COMPLETED

See Also:

Constant Field Values

DEFAULT_BATCH_SIZE

public static final int DEFAULT_BATCH_SIZE

See Also:

Constant Field Values

QUOTA_STATS_UPDATERS_EP

public static final String QUOTA_STATS_UPDATERS_EP

See Also:

Constant Field Values

Constructor Detail

QuotaStatsServiceImpl

public QuotaStatsServiceImpl()

Method Detail

activate

public void activate(ComponentContext context)

Description copied from interface: Component

Activates the component.

This method is called by the runtime when a component is activated.

Specified by:

activate in interface Component

Overrides:

activate in class DefaultComponent

Parameters:

context - the runtime context

getQuotaStatsUpdaters

public List<QuotaStatsUpdater> getQuotaStatsUpdaters()

Specified by:

getQuotaStatsUpdaters in interface QuotaStatsService

getQuotaStatsUpdaters

public QuotaStatsUpdater getQuotaStatsUpdaters(String updaterName)

updateStatistics

public void updateStatistics(DocumentEventContext docCtx,
                             Event event)
                      throws ClientException

Description copied from interface: QuotaStatsService

Update the statistics for the given docCtx and event.

Call all the registered QuotaStatsUpdaters.

Specified by:

updateStatistics in interface QuotaStatsService

Throws:

ClientException

computeInitialStatistics

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

Description copied from interface: QuotaStatsService

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

Specified by:

computeInitialStatistics in interface QuotaStatsService

launchInitialStatisticsComputation

public void launchInitialStatisticsComputation(String updaterName,
                                               String repositoryName)

Description copied from interface: QuotaStatsService

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

Specified by:

launchInitialStatisticsComputation in interface QuotaStatsService

getProgressStatus

public String getProgressStatus(String updaterName,
                                String repositoryName)

Description copied from interface: QuotaStatsService

Returns the progress status of updaterName.

Specified by:

getProgressStatus in interface QuotaStatsService

registerContribution

public void registerContribution(Object contribution,
                                 String extensionPoint,
                                 ComponentInstance contributor)

Overrides:

registerContribution in class DefaultComponent

unregisterContribution

public void unregisterContribution(Object contribution,
                                   String extensionPoint,
                                   ComponentInstance contributor)

Overrides:

unregisterContribution in class DefaultComponent

getQuotaFromParent

public long getQuotaFromParent(DocumentModel doc,
                               CoreSession session)
                        throws ClientException

Description copied from interface: QuotaStatsService

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

Specified by:

getQuotaFromParent in interface QuotaStatsService

Throws:

ClientException

activateQuotaOnUserWorkspaces

public void activateQuotaOnUserWorkspaces(long maxQuota,
                                          CoreSession session)
                                   throws ClientException

Description copied from interface: QuotaStatsService

Activates the quota on user personal workspaces

Specified by:

activateQuotaOnUserWorkspaces in interface QuotaStatsService

Throws:

ClientException

getQuotaSetOnUserWorkspaces

public long getQuotaSetOnUserWorkspaces(CoreSession session)
                                 throws ClientException

Specified by:

getQuotaSetOnUserWorkspaces in interface QuotaStatsService

Throws:

ClientException

launchSetMaxQuotaOnUserWorkspaces

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

Description copied from interface: QuotaStatsService

Sets this maxQuota on all user workspaces

Specified by:

launchSetMaxQuotaOnUserWorkspaces in interface QuotaStatsService

Throws:

ClientException

getUserWorkspaceRootId

public String getUserWorkspaceRootId(DocumentModel context,
                                     CoreSession session)
                              throws ClientException

Throws:

ClientException

canSetMaxQuota

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

Description copied from interface: QuotaStatsService

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

Specified by:

canSetMaxQuota in interface QuotaStatsService

Throws:

ClientException