org.alfresco.repo.usage

Class ContentUsageImpl

java.lang.Object

org.alfresco.repo.usage.ContentUsageImpl

All Implemented Interfaces:

NodeServicePolicies.BeforeDeleteNodePolicy, NodeServicePolicies.OnCreateNodePolicy, NodeServicePolicies.OnUpdatePropertiesPolicy, ClassPolicy, Policy, ContentUsageService

public class ContentUsageImpl
extends Object
implements ContentUsageService, NodeServicePolicies.OnUpdatePropertiesPolicy, NodeServicePolicies.BeforeDeleteNodePolicy, NodeServicePolicies.OnCreateNodePolicy

Implements Content Usage service and policies/behaviour.

Nested Class Summary

Nested classes/interfaces inherited from interface org.alfresco.repo.policy.Policy

Policy.Arg

Field Summary

Fields inherited from interface org.alfresco.repo.node.NodeServicePolicies.OnUpdatePropertiesPolicy

ARG_0, ARG_1, ARG_2, QNAME

Fields inherited from interface org.alfresco.repo.node.NodeServicePolicies.BeforeDeleteNodePolicy

QNAME

Fields inherited from interface org.alfresco.repo.node.NodeServicePolicies.OnCreateNodePolicy

QNAME

Fields inherited from interface org.alfresco.repo.policy.Policy

NAMESPACE

Constructor Summary

Constructors

Constructor and Description
ContentUsageImpl()

Method Summary

Modifier and Type	Method and Description
void	beforeDeleteNode(org.alfresco.service.cmr.repository.NodeRef nodeRef) Called before a node is deleted.
boolean	getEnabled() Are ContentUsages enabled (refer to 'system.usages.enabled' repository property) ?
List<String>	getStores()
long	getUserQuota(String userName) Gets user quota Note: -1 means no quota limit set
long	getUserStoredUsage(org.alfresco.service.cmr.repository.NodeRef personNodeRef)
long	getUserUsage(org.alfresco.service.cmr.repository.NodeRef personNodeRef, boolean removeDeltas)
long	getUserUsage(String userName) Gets user usage
void	init() The initialise method
void	onCreateNode(org.alfresco.service.cmr.repository.ChildAssociationRef childAssocRef) Called when a new node has been created.
void	onUpdateProperties(org.alfresco.service.cmr.repository.NodeRef nodeRef, Map<org.alfresco.service.namespace.QName,Serializable> before, Map<org.alfresco.service.namespace.QName,Serializable> after) Called after a node's properties have been changed.
void	setAuthenticationContext(AuthenticationContext authenticationContext)
void	setEnabled(boolean enabled)
void	setExcludedTypes(List<String> excludedTypes)
void	setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
void	setPersonService(PersonService personService)
void	setPolicyComponent(PolicyComponent policyComponent)
void	setStores(List<String> stores)
void	setTenantService(org.alfresco.repo.tenant.TenantService tenantService)
void	setUsageService(UsageService usageService)
void	setUserQuota(String userName, long currentQuota) Set user's current quota.
void	setUserStoredUsage(org.alfresco.service.cmr.repository.NodeRef personNodeRef, long currentUsage) Set user's usage.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentUsageImpl

public ContentUsageImpl()

Method Detail

setNodeService

public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)

setPersonService

public void setPersonService(PersonService personService)

setUsageService

public void setUsageService(UsageService usageService)

setPolicyComponent

public void setPolicyComponent(PolicyComponent policyComponent)

setAuthenticationContext

public void setAuthenticationContext(AuthenticationContext authenticationContext)

setTenantService

public void setTenantService(org.alfresco.repo.tenant.TenantService tenantService)

setEnabled

public void setEnabled(boolean enabled)

setStores

public void setStores(List<String> stores)

getStores

public List<String> getStores()

setExcludedTypes

public void setExcludedTypes(List<String> excludedTypes)

init

public void init()

The initialise method

onCreateNode

public void onCreateNode(org.alfresco.service.cmr.repository.ChildAssociationRef childAssocRef)

Description copied from interface: NodeServicePolicies.OnCreateNodePolicy

Called when a new node has been created.

Specified by:

onCreateNode in interface NodeServicePolicies.OnCreateNodePolicy

Parameters:

childAssocRef - the created child association reference

onUpdateProperties

public void onUpdateProperties(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                               Map<org.alfresco.service.namespace.QName,Serializable> before,
                               Map<org.alfresco.service.namespace.QName,Serializable> after)

Called after a node's properties have been changed.

Specified by:

onUpdateProperties in interface NodeServicePolicies.OnUpdatePropertiesPolicy

Parameters:

nodeRef - reference to the updated node

before - the node's properties before the change

after - the node's properties after the change

beforeDeleteNode

public void beforeDeleteNode(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Called before a node is deleted.

Specified by:

beforeDeleteNode in interface NodeServicePolicies.BeforeDeleteNodePolicy

Parameters:

nodeRef - the node reference

setUserStoredUsage

public void setUserStoredUsage(org.alfresco.service.cmr.repository.NodeRef personNodeRef,
                               long currentUsage)

Set user's usage. Should only be called by background (collapse) job !

Parameters:

personNodeRef - person nodeRef

currentUsage - long

getUserStoredUsage

public long getUserStoredUsage(org.alfresco.service.cmr.repository.NodeRef personNodeRef)

getUserUsage

public long getUserUsage(String userName)

Description copied from interface: ContentUsageService

Gets user usage

Specified by:

getUserUsage in interface ContentUsageService

Returns:

Return user's current calculated usage (in bytes)

getUserUsage

public long getUserUsage(org.alfresco.service.cmr.repository.NodeRef personNodeRef,
                         boolean removeDeltas)

setUserQuota

public void setUserQuota(String userName,
                         long currentQuota)

Set user's current quota. Usually called by Web Client (Admin Console) if admin is changing/setting a user's quota.

Specified by:

setUserQuota in interface ContentUsageService

Parameters:

userName - user name

currentQuota - User's new quota (in bytes)

getUserQuota

public long getUserQuota(String userName)

Description copied from interface: ContentUsageService

Gets user quota Note: -1 means no quota limit set

Specified by:

getUserQuota in interface ContentUsageService

Returns:

Return user's quota (in bytes).

getEnabled

public boolean getEnabled()

Description copied from interface: ContentUsageService

Are ContentUsages enabled (refer to 'system.usages.enabled' repository property) ?

Specified by:

getEnabled in interface ContentUsageService

Returns:

true if ContentUsages are enabled, otherwise false